r - 用Roxygen记录R.oo类/方法

有人可以指出我一个用Roxygen记录R.oo类/方法的好例子吗？在R.oo中，类/方法是通过对setConstructorS3()和setMethodS3()的调用来创建的，因此本身没有文档功能。您是否只是创建标准的Roxygen函数文档，而是将其放在NULL语句的顶部？

最佳答案

我认为，

@usage是必需的。

为了S3通用/方法的一致性，在MyMethod.ClassName函数中需要一个点-点-点参数。

不是#' @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
})

关于r - 用Roxygen记录R.oo类/方法，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/7198858/

myMethod

r - 用Roxygen记录R.oo类/方法