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