使用 roxygen 记录 setter 函数

Question

我有一个函数，它的作用只不过是向任何 R 对象添加唯一的 attr 。基本演示：

#' 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) < ;-值。

任何提示将非常感激！

---

更新：感谢richierocks，似乎有一个修复

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