R parse_Rd 解析 Rd 文件

说明

此函数读取 R 文档 (Rd) 文件并对其进行解析，以供其他函数处理。

用法

parse_Rd(file, srcfile = NULL, encoding = "unknown",
         verbose = FALSE, fragment = FALSE, warningCalls = TRUE,
	 macros = file.path(R.home("share"), "Rd", "macros", "system.Rd"),
         permissive = FALSE)
## S3 method for class 'Rd'
print(x, deparse = FALSE, ...)
## S3 method for class 'Rd'
as.character(x, deparse = FALSE, ...)

参数

file	文件名或文本模式连接。目前文件名效果最好。
srcfile	NULL 或 "srcfile" 对象。请参阅“详细信息”部分。
encoding	输入字符串假定的编码。
verbose	逻辑指示是否应该打印详细的解析信息。
fragment	逻辑指示文件是代表完整的 Rd 文件还是片段。
warningCalls	逻辑：解析器警告是否应该包含调用？
macros	从中加载附加宏的文件名或环境，或逻辑值。请参阅下面的详细信息。
permissive	逻辑表明无法识别的宏应被视为文本而不发出警告。
x	Rd 类的对象。
deparse	如果是 TRUE ，则尝试恢复转义字符，以便结果字符将解析为同一对象。
...	要传递给其他方法或从其他方法传递的更多参数。

细节

该函数解析‘路' 根据中给出的规范的文件https://developer.r-project.org/parseRd.pdf.

它会为每个解析错误生成警告并尝试继续解析。为了继续，通常需要删除文件的某些部分，因此不应忽略此类警告。

没有标记编码的文件默认假定为本机编码。可以使用 encoding 参数设置备用默认值。文件中的所有文本都会转换为解析对象中的 UTF-8 编码。

来自R版本 3.2.0，用户定义的宏可以在单独的文件中使用‘⁠\新命令⁠' 或者 '⁠\更新命令⁠’。还可以给出一个环境：它将由loadRdMacros,loadPkgRdMacros，或者通过之前的调用parse_Rd。如果给出逻辑值，则仅使用默认的内置宏；FALSE表明没有"macros"属性将随结果一起返回。

permissive 参数允许解析不完全为 Rd 格式的文本。通常它是 LaTeX 代码，用在 Rd 片段中，例如在 bibentry 中。对于 permissive = TRUE ，这将以纯文本形式传递。由于 parse_Rd 不知道 LaTeX 宏中有多少个参数，因此它会根据宏后面是否存在大括号来猜测；这并非绝对正确。

值

parse_Rd 返回类 "Rd" 的对象。该对象的内部格式可能会发生变化。为类定义的 as.character() 和 print() 方法分别返回字符向量并打印它们。

除非 macros = FALSE ，否则该对象将具有名为 "macros" 的属性，该属性是包含 file 中定义的宏的环境，其格式可用于同一会话中进一步的 parse_Rd 调用。如果保存到文件并在不同的会话中重新加载，则不能保证它可以工作。

作者

Duncan Murdoch

参考

https://developer.r-project.org/parseRd.pdf

也可以看看

Rd2HTML 用于使用 parse_Rd() 输出的转换器。