记录`..`

时间:2018-03-30 07:39:20

标签: r roxygen2

我正在尝试使用roxygen来记录和导出一个名为..的函数 - 我将它用于某些模式匹配,并希望在表达式中不占用太多空间的名称但是我不想与.

发生冲突

它看起来像这样:

#' Function for specifying a sequence of patterns/expressions
#'
#' This function is used when you want to test for more than one pattern
#' in parallel
#'
#' @param ... The patterns/expressions to combine
#'
#' @export
`..` <- function(...) structure(list(...), class = "..")

然而,我收到错误

Updating pmatch documentation
Loading pmatch
Skipping invalid path:  ...Rd 
Documentation completed

我想..不是R喜欢的man-pages这个名字,但有没有办法为这个函数创建文档?或者我必须重命名吗?

2 个答案:

答案 0 :(得分:3)

您可以使用:

#' @rdname dotdot

然后它将创建dotdot.Rd

答案 1 :(得分:1)

啊,答案很简单。我只需要使用

为函数指定一个显式名称
#' @name `..`

然后它有效。