在 R 包中记录 S4 类的推荐方法

问题描述

遵循 Hadley Wickham 和 Jenny Bryan 的 R 包中的示例。我正在研究使用 roxygen2 为 S4 对象生成文档的建议方法。该示例在 section 10.7.2 中可用，内容如下：

通过在 setClass() 之前添加 roxygen 块来记录 S4 类。采用 @slot 以您使用的相同方式记录类的插槽 @param 来描述函数的参数。这里有一个简单的 例子：

#' An S4 class to represent a bank account.
#'
#' @slot balance A length-one numeric vector
Account <- setClass("Account",slots = list(balance = "numeric")
)

结果

如果遵循这会生成两个具有相同内容的文档文件。正式地说，Account 中描述了 Account 对象和 Account-class 类。

注意事项

拥有 Account 对象是有意义的，因为它可以很容易地用于创建该类的新实例。但是，我发现将一个文档条目仅用作 Account-class 就足够了。

解决方案尝试

将 #' @rdname Account-class 或 #' @name Account-class 添加到 Account-class 仍会导致生成两个文档条目。

问题

1. 为什么需要两个相同的文档条目，一个 Classname 和另一个 Classname-class 具有相同的内容，是否有实际原因？
2. 使用 roxygen2 和名为 Classname-class.R 的文件并创建对象 Classname <- setClass() 来记录 S4 类的好方法是什么？在所需的场景中，会发生以下情况：
   • 定义新类Newclass-class.R文件
   • 类定义的格式为 Newclass <- setClass("Newclass",...
   • 该文件中可用的 roxygen 标签只会生成一个文档条目：Newclass-class 正在创建

解决方法

暂无找到可以解决该程序问题的有效方法，小编努力寻找整理中！

如果你已经找到好的解决方法，欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@）