记录`..`
Documenting `..`
我正在尝试使用 roxygen 来记录和导出我命名的函数 .. -- 我将它用于一些模式匹配，并且想要一个不会占用太多空间的名称 space 在表达式中，但我不想与 .
冲突
看起来像这样：
#' 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 手册页喜欢的名称，但是有什么方法可以为这个函数创建文档吗？还是我必须重命名它？
啊，答案很简单。我只需要使用
给函数一个明确的名称
#' @name `..`
然后就可以了。
您可以使用：
#' @rdname dotdot
然后它将创建dotdot.Rd
我正在尝试使用 roxygen 来记录和导出我命名的函数 .. -- 我将它用于一些模式匹配，并且想要一个不会占用太多空间的名称 space 在表达式中，但我不想与 .
看起来像这样：
#' 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 手册页喜欢的名称，但是有什么方法可以为这个函数创建文档吗？还是我必须重命名它？
啊，答案很简单。我只需要使用
给函数一个明确的名称#' @name `..`
然后就可以了。
您可以使用：
#' @rdname dotdot
然后它将创建dotdot.Rd