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) <- value时触发警告，因为它应该是{{1}}。

任何提示都会非常有意义！

更新：感谢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

使用roxygen记录setter函数

1 个答案: