使用 Roxygen 记录 R.oo 类/方法

发布于 2024-12-01 15:09:41 字数 153 浏览 0 评论 0原文

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

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

手心的温暖 2024-12-08 15:09:41

我认为，

需要 @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
})

I think,

@usage are needed.
A dot-dot-dot argument is needed in the MyMethod.ClassName function for S3 generic/method consistency.
Not #' @export MyMethod.ClassName but rather #' @S3method MyMethod ClassName?

An example code:

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

回复收藏 0 原文

夜唯美灬不弃 2024-12-08 15:09:41

经过一番尝试后错误，这就是我想出的。该解决方案确保所有对象都正确导出，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 ) { ... } )

After some trial & error, here's what I came up with. This solution ensures that all objects are exported properly, that R CMD build/check does not puke, that there is no redundant documentation, and that examples will execute. Note that the solution won't work if @export is replaced with @method/@S3method. Theoretically that should work, but it didn't for me. Someone have a better solution?

#' 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 ) { ... } )

回复收藏 0 原文

~没有更多了~