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

Question

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

在其他包总是有每个帮助页面底部的链接，导致索引页：

Screenshot from dplyr package (exemplary index link)

我怎样才能建立/链路与devtools此索引页？

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

Note that this only renders a single documentation file, so that links to other files within the package won't work.

那么我该如何使用正常的文档而不是dev-help？

Answer 1

找到解决方案。如果你有以下流程：

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

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

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