Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

help

Display module documentation


Description

help displays help on a module’s objects and functions in much the same way help does for package contents.

Usage

help(topic, help_type = getOption("help_type", "text"))

Arguments

topic

either the fully-qualified name of the object or function to get help for, in the format module$function; or a name that was exported and attached from an imported module or package.

help_type

character string specifying the output format; currently, only 'text' is supported.

Details

See the vignette in vignette('box', 'box') for more information on displaying help for modules.

Value

help is called for its side-effect when called directly from the command prompt.


box

Write Reusable, Composable and Modular R Code

v1.0.2
MIT + file LICENSE
Authors
Konrad Rudolph [aut, cre] (<https://orcid.org/0000-0002-9866-7051>), Michael Schubert [ctb] (<https://orcid.org/0000-0002-6862-5221>)
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.