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

Question

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

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

Screenshot from dplyr package (exemplary index link)

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

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

  

请注意，这只会呈现单个文档文件，因此指向包中其他文件的链接将无效。

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

Answer 1

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

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

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

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