R Rdindex 从 Rd 文件生成索引

R语言 Rdindex 位于 tools 包(package)。

将包含给定 R 文档文件的名称和标题的 2 列索引表打印到给定的输出文件或连接。标题的格式很好地位于两个列位置(通常分别为 25 和 72)之间。

Rdindex(RdFiles, outFile = "", type = NULL,
        width = 0.9 * getOption("width"), indent = NULL)

`RdFiles`	一个字符向量，指定用于创建索引的 Rd 文件，通过给出文件的路径或包含包源的单个目录的路径。
`outFile`	连接或命名要打印到的输出文件的字符串。 `""`(默认)表示输出到控制台。
`type`	给出要包含在索引中的 Rd 文件的文档类型的字符串，或 `NULL`(默认值)。 Rd 文件的类型通常通过 `⁠\docType⁠` 标签指定；如果 `type` 是 `"data"` ，则也包含唯一关键字为 `datasets` 的 Rd 文件。
`width`	一个正整数，给出在输出中换行的目标列。
`indent`	一个正整数，指定第二列的缩进。不得大于 `width/2` ，默认为 `width/3` 。

如果名称不是有效的别名，则使用第一个别名(如果没有，则使用空字符串)。

相关用法

注：本文由纯净天空筛选整理自R-devel大神的英文原创作品 Generate Index from Rd Files。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。