【发布时间】:2015-06-07 09:25:58
【问题描述】:
我应该如何为 R 参考类编写文档?我查看了 CRAN 上的“编写 R 扩展”,但只找到了 S3 和 S4 对象的说明。
谁能提供 R ref 类及其相关方法的文档示例?
【问题讨论】:
标签: r
我应该如何为 R 参考类编写文档?我查看了 CRAN 上的“编写 R 扩展”,但只找到了 S3 和 S4 对象的说明。
谁能提供 R ref 类及其相关方法的文档示例?
【问题讨论】:
标签: r
documentation for setRefClass 解释了这一切,并举例说明。您可以在方法定义中将方法的帮助文本作为字符串添加:
方法的文档可以通过生成器对象的
$help方法获得。类的方法没有以用于 R 函数的 Rd 格式记录。相反,$help方法以 Python 的风格打印方法的调用序列,然后是方法定义中的自文档。如果方法主体的第一个元素是文字字符串(可能是多行),则该字符串被解释为文档。
【讨论】: