使用 devtools 为 R 包创建主要帮助页面（索引）

Question

我正在使用 devtools 构建 R 包。所有文档都是使用 roxygen2 构建的。对于这些功能来说，这一切都很好，但是我如何为整个包提供一个帮助页面，其中列出了所有可用的功能。

在其他软件包中，每个帮助页面的底部始终有一个指向索引页面的链接：

dplyr 包的屏幕截图（示例索引链接）

如何使用 devtools 构建/链接此索引页面？

编辑：如果我通过“？functionName”访问帮助页面，还会将以下输出打印到控制台“使用 functionName 的开发文档”。从 devtools 的 github 存储库中，我找到了 提供此输出的函数 dev-help.R 。在其评论中指出，链接不适用于此开发帮助。

请注意，这仅呈现单个文档文件，因此到包内其他文件的链接将不起作用。

那么如何使用普通文档而不是 dev-help 呢？

Answer 1

找到了解决方案。如果您有以下工作流程：

1. create()
2. document()
3. build()
4. install.packages()
5. library(<pkg-name>)

文档将在 期间加载到 R 的命名空间中document()。因此，稍后的 调用?functionName将指的是文档的开发阶段，而不是编译包提供的阶段。

因此，安装后创建一个新的 R 会话就可以解决问题！