R loadRdMacros 加载用户定义的 Rd 帮助系统宏

说明

从‘加载宏.Rd' 文件，或来自多个 '.Rd' 包中包含的文件。

用法

loadRdMacros(file, macros = TRUE)
loadPkgRdMacros(pkgdir, macros = NULL)

参数

file	包含宏定义的 Rd 格式的文件。
macros	(可选)一组先前的宏定义，采用 parse_Rd macros 参数所需的格式。 loadPkgRdMacros 默认加载系统 Rd 宏。
pkgdir	源包或已安装包的基目录。

细节

这些函数解析的Rd文件应该只包含宏定义；如果发现除注释或空白之外的任何其他内容，则会发出警告。

macros 参数可以是基本宏集的文件名，或者是同一会话中先前调用 loadRdMacros 或 loadPkgRdMacros 的结果。应假定这些结果仅在当前会话内有效。

loadPkgRdMacros函数首先寻找"RdMacros"包中的条目‘DESCRIPTION' 文件。如果存在，它应该包含其他包名称的逗号分隔列表；它们的宏将在当前包的宏之前加载。然后它将在当前包中查找‘.Rd' 中的文件人/宏' 或者 '帮助/宏’子目录，然后加载它们。

值

这些函数各自返回一个环境，其中包含对象以及上次处理的文件中新定义的宏的名称。父环境将是前一个文件中的宏，依此类推。处理的第一个文件将以 emptyenv() 作为其父文件。

例子

f <- tempfile()
writeLines(r"(
\newcommand{\Rlogo}{
  \if{html}{\figure{Rlogo.svg}{options: width=100 alt="R logo"}}
  \if{latex}{\figure{Rlogo.pdf}{options: width=0.5in}}
}
)", f)
m <- loadRdMacros(f)
ls(m)
ls(parent.env(m))  
ls(parent.env(parent.env(m)))
parse_Rd(textConnection(r"(\Rlogo)"), fragment = TRUE, macros = m)

作者

Duncan Murdoch

参考

See the ‘Writing R Extensions’ manual for the syntax of Rd files, or https://developer.r-project.org/parseRd.pdf for a technical discussion.

也可以看看

parse_Rd