Load user-defined Rd help system macros.
Loads macros from an ‘.Rd’ file, or from several ‘.Rd’ files contained in a package.
A file in Rd format containing macro definitions.
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.
macros argument may be a filename of a base set of macros,
or the result of a previous call to
loadPkgRdMacros in the same session. These results should be
assumed to be valid only within the current session.
loadPkgMacros function first looks for an
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
See the ‘Writing R Extensions’ manual for the syntax of Rd files, or https://developer.r-project.org/parseRd.pdf for a technical discussion.
1 2 3 4 5 6 7 8