将部分添加到 R 包的帮助/文档中答案

【问题标题】：Add sections to R package's help/documentation将部分添加到 R 包的帮助/文档中
【发布时间】：2016-06-10 19:50:01
【问题描述】：

一些R 软件包（例如，ggplot2、dplyr、devtools 等）在其帮助/文档中具有按字母顺序命名的部分以及指向这些部分的链接栏（在下图中用红色箭头表示）。其他包（例如，RcmdrMisc）没有。

如何将这些元素添加到 may R 包的帮助中？

我将roxygen2 用于文档。

【问题讨论】：

【解决方案1】：

在编写 R 扩展文件（包含在 CRAN 的每个 R 副本中）中是关于 INDEX 文件的一小部分：

1.1.4 索引文件

可选文件 INDEX 包含包中每个足够有趣的对象的一行，给出其名称和描述（可能不包括通常不显式调用的打印方法等函数）。通常情况下，此文件会丢失，并且在从源安装时会自动从文档源（使用tools::Rdindex()）生成相应的信息。

当包有索引文件时，HTML 代码位于html 文件夹中。

【讨论】：

我在我的包的安装版本中找到了html文件夹，但我仍然不明白如何制作部分。函数tools::Rdindex()是否负责在安装包的过程中制作带有索引的HTML文件？
即使 INDEX 文件对对象有特殊的顺序，最终的顺序也是按字母顺序排列的。也没有分段的可能性。（例如，请参阅 gtools。）
正确。 User2554330 在几个月前向支持部分的pkgdown::build_reference 函数添加了一个有用的指针。我怀疑问题首次出现时该设施不可用。 MrFlick 补充了一点，解释了为什么一些 pkg 索引有首字母“部分”而其他没有。（它不受用户控制。）

【解决方案2】：

安装包时，R 会自动生成帮助索引页面。但请注意，仅当索引页面上的项目超过 100 条时才会生成字母索引。目前没有办法改变这种行为。我发现在code for installing packages

【讨论】：

【解决方案3】：

正如@iRTFM 和@MrFlick 所说，您不能影响R 显示的索引。但是，如果您使用pkgdown 包制作包网页，则可以完全控制主索引以获取帮助页。例如，参见

关于如何指定索引的描述在帮助页面?pkgdown::build_reference中给出，显示在这里：

【讨论】：