用Roxygen记录R.oo类/方法

Question

有人能给我指出一个用Roxygen记录R.oo类/方法的好例子吗?在R.oo中，类/方法是通过调用setConstructorS3()和setMethodS3()来创建的，因此不需要记录函数本身。您是否只是简单地创建标准的氧函数文档，但将其放在NULL语句的顶部?

Answer 1

我想，

1. 需要@usage
2. 为了S3泛型/方法的一致性，MyMethod.ClassName函数中需要一个dot-dot-dot参数。
3. 不是#' @export MyMethod.ClassName而是#' @S3method MyMethod ClassName ?

示例代码:

#' Title.  More Info.
#'
#' @usage MyMethod(...)
#' @param this this.
#' @param someParam Param info.
#' @param ... other arguments.
#'
#' @rdname   MyMethod
#' @export   MyMethod
#' @name     MyMethod
NULL
#' @usage method{MyMethod}{ClassName}(this, someParam, ...)
#' @return MyMethod.ClassName:
#' code{NULL}
#'
#' @rdname   MyMethod
#' @S3method MyMethod ClassName
#' @name     MyMethod.ClassName
setMethodS3("MyMethod", "ClassName", appendVarArgs = FALSE, 
function(this, someParam, ...) {
  NULL
})

Answer 2

经过一番尝试&错误，这是我想出来的。此解决方案确保所有对象都正确导出，R CMD构建/检查不会呕吐，没有多余的文档，并且示例将执行。注意，如果将@export替换为@method/@S3method，解决方案将无法工作。理论上这应该行得通，但对我来说却行不通。有人有更好的解决办法吗?

#' Title.  More Info.
#'
#' @param someParam  Param info.
#'
#' @name     MyMethod
#' @export   MyMethod
NULL
#' @rdname   MyMethod
#' @name     MyMethod.ClassName
#' @export   MyMethod.ClassName
setMethodS3( "MyMethod" , "ClassName" , appendVarArgs = FALSE , 
function( this , someParam ) { ... } )