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

Question

某些R个软件包（例如，ggplot2，dplyr，devtools等）在其帮助/文档中按字母顺序排列了标题部分，并指向这些部分的链接栏（由下图中的红色箭头表示）。其他套餐（例如RcmdrMisc）没有。

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

我使用roxygen2作为文档。

Answer 1

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

  

1.1.4 INDEX文件

     

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

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

Answer 2

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

Answer 3

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

https://ggplot2.tidyverse.org/reference/index.html

有关如何指定索引的说明在帮助页面 ?pkgdown::build_reference 中给出，显示在此处：

https://pkgdown.r-lib.org/reference/build_reference.html