我想这是我在文档中一直忽略的一件简单的事情,但我似乎无法弄清楚如何让包级文档在 R 中工作。我不是指函数或特定于类的文档,而是键入时获得的文档,例如 ?stats。
我遵循了我在网上找到的一般说明,创建了一个保存为 .R 的 sckeleton 文档文件。.R 文件与包脚本一起复制,但帮助文档不会被制作成 .Rd 文件(除非我添加了一个也以包命名的函数定义)。
我尝试过的一个例子:
#'_PACKAGE
#'MyPackage
#'
#'MyPackage description
#'
#'MyPackage details
#'@alias{MyPackage}
#'@alias{MyPackage-package}
出于某种原因,我很难找到如何设置通用包文档的好例子。我已经编写了很多函数帮助文件,并且我知道我的包帮助文件正在被 roxygen 找到,但不清楚为什么我不能从中生成 .Rd。