r - 使用 devtools 为 R 包创建主帮助页面(索引)

Question

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

在其他包中，每个帮助页面的底部总是有一个链接，该链接指向索引页面:

Screenshot from dplyr package (exemplary index link)

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

编辑:如果我通过“？functionName”访问帮助页面，还会有以下输出打印到控制台“Using development documentation for 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

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

create()

document()

build()

install.packages()

library(<pkg-name>)

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

因此，在安装后创建一个新的 R session 就可以解决问题!