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。非經特殊聲明，原始代碼版權歸原作者所有，本譯文未經允許或授權，請勿轉載或複製。