使用 roxygen 的内联包概述文档
Inline package overview documentation using roxygen
我想这是我在文档中一直忽略的一件简单的事情，但我似乎无法弄清楚如何让包级文档在 R 中工作。我不是指函数或 class-特定文档，但是当您键入时获得的文档，例如，?stats.
我按照我在网上找到的一般说明创建了一个保存为 .R 的 sckeleton 文档文件。 .R 文件与包脚本一起复制，但帮助文档不会制作成 .Rd 文件（除非我添加一个也以包命名的函数定义）。
我尝试过的示例：
#'_PACKAGE
#'MyPackage
#'
#'MyPackage description
#'
#'MyPackage details
#'@alias{MyPackage}
#'@alias{MyPackage-package}
出于某种原因，我很难找到有关如何设置通用包文档的好示例。我写了很多功能帮助文件，我知道我的包帮助文件正在被 roxygen 找到，但不清楚为什么我不能从中生成 .Rd。
以上评论中@slickrickulicious 的回答：
我需要在文档文件末尾添加 NULL 并包含“@name MyPackage”。这样做会正确生成软件包帮助文件。
我想这是我在文档中一直忽略的一件简单的事情，但我似乎无法弄清楚如何让包级文档在 R 中工作。我不是指函数或 class-特定文档，但是当您键入时获得的文档，例如，?stats.
我按照我在网上找到的一般说明创建了一个保存为 .R 的 sckeleton 文档文件。 .R 文件与包脚本一起复制，但帮助文档不会制作成 .Rd 文件（除非我添加一个也以包命名的函数定义）。
我尝试过的示例：
#'_PACKAGE
#'MyPackage
#'
#'MyPackage description
#'
#'MyPackage details
#'@alias{MyPackage}
#'@alias{MyPackage-package}
出于某种原因，我很难找到有关如何设置通用包文档的好示例。我写了很多功能帮助文件，我知道我的包帮助文件正在被 roxygen 找到，但不清楚为什么我不能从中生成 .Rd。
以上评论中@slickrickulicious 的回答：
我需要在文档文件末尾添加 NULL 并包含“@name MyPackage”。这样做会正确生成软件包帮助文件。