r - 使用 roxygen 记录 setter 函数

Question

我有一个功能，它只做一个独特的广告 attr到任何 R 对象。基础演示:

#' Setter function
#' @param x an R object
#' @param value a character value to set
#' @export
`foo<-` <- function(x, value){
    attr(x, 'foo') <- value
    return(x)
}

这就像一个魅力，除了生成一个好的 Rd 文件，相关部分:

\usage{
  foo(var, value) <- value
}

当然，它会在运行时触发警告 R CMD check应该是 foo(var) <- value .

任何提示都会非常感激!

更新 : 感谢 richierocks似乎有一个 fix

Answer 1

您可以使用 roxygen 标签 @usage
这是我的一个软件包中的一个示例:

#' @rdname pattern
#' @usage pattern(x) <- value
#' @param value New value
#' @export pattern<-
"pattern<-" <- function(x, value=c("^", "($|(_\\d+(_\\d+)*)$)")){
  attr(x, "pattern") <- value
  x
}

这导致我想要的文档:

Usage

  pattern(x) <- value

Arguments
x surveydata object

value New value