gpt4 book ai didi

r - 如何记录 R6 类的 S3 泛型?

转载 作者:行者123 更新时间:2023-12-04 10:10:45 25 4
gpt4 key购买 nike

我有一个 R6 类 myclass ,并且我已经定义了 S3 泛型 as.matrix为了它。一切正常,但是当我运行 R CMD 检查时,我收到了 2 个注释:

注 1:

  S3 methods shown with full name in documentation object 'as.matrix.myclass':
'as.matrix.myclass'

The \usage entries for S3 methods should use the \method markup and not
their full name.
See chapter 'Writing R documentation files' in the 'Writing R
Extensions' manual.

笔记2:
Found the following apparent S3 methods exported but not registered:
as.matrix.myclass
See section 'Registering S3 methods' in the 'Writing R Extensions'
manual.

这是我如何定义和记录我的 S3 泛型(这是在 R6 类之外):
#' Converts all cores to R matrices
#'
#' @param x \code{myclass}
#' @param ... other arguments passed to \code{as.matrix()}
#' @return A named list of R matrices.
#' @export

as.matrix.myclass <- function(x, ...) {
sapply(
x$cores,
function(x, ...) as.matrix(x, ...),
USE.NAMES = TRUE, simplify = FALSE
)
}

我正在使用支持 R6 文档的较新版本的 roxygen,但我找不到有关如何删除这些注释的任何信息。谢谢!

最佳答案

正如@Mikko 建议的那样,我更新了我的 roxygen 版本(我的原始帖子现在已经很旧了)。在 7.1.1 中,我不再收到注释。谢谢!

关于r - 如何记录 R6 类的 S3 泛型?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/61351475/

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com