In-development help for package loaded with devtools
Source:R/dev-help.R
, R/dev-topic.R
dev_help.Rd
dev_help
searches for source documentation provided in
packages loaded by devtools. To improve performance, the .Rd
files
are parsed to create to index once, then cached. Use
dev_topic_index_reset
to clear that index.
Usage
dev_help(
topic,
dev_packages = NULL,
stage = "render",
type = getOption("help_type")
)
dev_topic_find(topic, dev_packages = NULL)
dev_topic_index_reset(pkg_name)
Arguments
- topic
name of help to search for.
- dev_packages
A character vector of package names to search within. If
NULL
, defaults to all packages loaded by devtools.- stage
at which stage ("build", "install", or "render") should
\\Sexpr
macros be executed? This is only important if you're using\\Sexpr
macro's in your Rd files.- type
of html to produce:
"html"
or"text"
. Defaults to your default documentation type.- pkg_name
Name of package.