【发布时间】：2015-12-23 16:29:21
【问题描述】：
我想这是我在文档中一直忽略的一件简单的事情，但我似乎无法弄清楚如何让包级文档在 R 中工作。我指的不是函数或特定于类文档，而是您在键入时获得的文档，例如 ?stats。
我按照我在网上找到的一般说明，创建了一个保存为 .R 的 sckeleton 文档文件。 .R 文件与包脚本一起复制，但帮助文档不会被制作成 .Rd 文件（除非我添加了一个也以包命名的函数定义）。
我尝试过的一个例子：
#'_PACKAGE
#'MyPackage
#'
#'MyPackage description
#'
#'MyPackage details
#'@alias{MyPackage}
#'@alias{MyPackage-package}
出于某种原因，我很难找到有关如何设置通用软件包文档的好示例。我已经编写了很多函数帮助文件，并且我知道我的包帮助文件正在被 roxygen 找到，但不清楚为什么我不能从中生成 .Rd。
【问题讨论】：
-
您确实需要在文档后面的行中添加
NULL。以See here 为例。 -
您可能想要更改问题的标题。这不是“整体包文档”。您知道如何在 Rd 文件中执行此操作——这是关于 roxygen2 的一个特定方面。
-
@slickrickulicious 同意。也可以试试
identical(NULL, {})，看看为什么两者都同样有效。 -
也更新了标题。我试图避免 cmets 关于如何记录函数而不是整个包。
-
原始评论的编辑：在我不应该有的时候在 '\name' 周围添加了花括号。删除后，它工作了！