loadRdMacros | R Documentation |
Loads macros from an ‘.Rd’ file, or from several ‘.Rd’ files contained in a package.
loadRdMacros(file, macros = TRUE) loadPkgRdMacros(pkgdir, macros)
file |
A file in Rd format containing macro definitions. |
macros |
|
pkgdir |
The base directory of a source package or an installed package. |
The files parsed by this function should contain only macro definitions; a warning will be issued if anything else other than comments or white space is found.
The macros
argument may be a filename of a base set of macros,
or the result of a previous call to loadRdMacros
or
loadPkgRdMacros
in the same session. These results should be
assumed to be valid only within the current session.
The loadPkgRdMacros
function first looks for an "RdMacros"
entry in the package ‘DESCRIPTION’ file. If present, it should
contain a comma-separated list of other package names; their macros
will be loaded before those of the current package. It will then look
in the current package for ‘.Rd’ files in the ‘man/macros’
or ‘help/macros’ subdirectories, and load those.
These functions each return an environment containing objects with the
names of the newly defined macros from the last file processed. The
parent environment will be macros from the previous file, and so on.
The first file processed will have emptyenv()
as its
parent.
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
f <- tempfile() writeLines(paste0("\\newcommand{\\logo}{\\if{html}{\\figure{Rlogo.svg}{options: width=100}", "\\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)))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.