Get help pages as Rd objects
Get a help page as an Rd object from an installed or source package.
Rdo_fetch(Rd_name = character(0), package, dir = ".", installed = TRUE)
names of one or more Rd help pages.
namehere is the name of an Rd file stripped from the extension.
the package from which to get the Rd object, a character string.
a character string giving the root directory of a source package. Used only if
TRUE, the default, the Rd object is taken unconditionally from the installed
FALSE, the help page may be taken from a source tree, if appropriate (typically if
packageis in `developer's mode under devtools, see Details).
Rd_name is a character string (typical use case), the
corresponding help page is returned as an object from class
"Rd". If the length of
Rd_name is greater than one, the
result is a Rd_named list containing the corresponding
objects. The default
Rd_name = character(0) requests all Rd
pages in the package.
Rd_name does not contain the extention
but the names in the returned list do.
package names the package from which to fetch the
documentation object. With the default
installed = TRUE the
object is taken unconditionally from the installed package. To get it
from the source tree of a package, use argument
dir is suitable for workflows where
the working directory is the root of the desired package.
installed concerns primarily development under package
"devtools" intercepts and modifies several
base R commands, concerning access to system files and getting help,
with the aim of rerouting them to the source trees of packages under
developer's mode. If argument
default, the requested pages are taken from the installed package,
even if it is in development mode. If argument
FALSE, the Rd objects are taken from the corresponding source
tree, if the specified package is under developer's mode, and from the
installed package otherwise.
Rd_name is the name used in the
of Rd files.
When working off the source tree of a package,
processes the Rd files, so
roxygen2 users need to update
them if necessary.