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 。