R RdTextFilter 選擇 Rd 文件中的文本

說明

此函數會清除 Rd 文件中的所有非文本，以進行拚寫檢查或其他用途。

用法

RdTextFilter(ifile, encoding = "unknown", keepSpacing = TRUE,
             drop = character(), keep = character(),
             macros = file.path(R.home("share"), "Rd", "macros", "system.Rd"))

參數

ifile	指定為文件名或連接的輸入文件，或 parse_Rd 中的 "Rd" 對象。
encoding	要傳遞給 parse_Rd 的編碼名稱。
keepSpacing	是否嘗試將文本保留在與原始文件中相同的行和列中。
drop	道路的其他部分將被刪除。
keep	Rd 文件中要保留的部分。
macros	解析時假設的宏定義。請參閱parse_Rd。

細節

該函數解析 Rd 文件，然後逐個元素地遍曆它。帶有標簽 "TEXT" 的項目保留在與原始文件中出現的位置相同的位置，而文件的其他部分則替換為空白，因此諸如 aspell 之類的拚寫檢查器隻能檢查文本並報告位置原始文件。 (如果 keepSpacing 是 FALSE ，則不會填充空白，並且文本不會在其原始位置輸出。)

默認情況下，會跳過標簽 ⁠\S3method⁠ , ⁠\S4method⁠ , ⁠\command⁠ , ⁠\docType⁠ , ⁠\email⁠ , ⁠\encoding⁠ , ⁠\file⁠ , ⁠\keyword⁠ , ⁠\link⁠ , ⁠\linkS4class⁠ , ⁠\method⁠ , ⁠\pkg⁠ 和 ⁠\var⁠。可以通過在 drop 參數中列出其他標簽來跳過它們；在 keep 參數中列出標簽將阻止它們被跳過。還可以 keep 任何 c("RCODE", "COMMENT", "VERB") 標記(分別對應於 R-like 代碼、注釋和逐字文本)，或刪除 "TEXT" 。

值

一種字符向量，如果將其寫入文件(每行一個元素)，則會複製原始 Rd 文件的文本元素。

注意

當 Rd 文件中的標記用於突出顯示單詞的開頭時，過濾器會嘗試將文本元素合並為單個單詞。

作者

Duncan Murdoch

也可以看看

aspell ，對此來說這是可接受的 filter 。