help

<code>box::help</code> displays help on a module’s objects and functions in much
the same way <code><a href="/link/help?package=box&version=1.2.0" data-mini-rdoc="box::help">help</a></code> does for package contents.

A modern module system for R. Organise code into hierarchical,
composable, reusable modules, and use it effortlessly across projects via a
flexible, declarative dependency loading syntax.

Konrad Rudolph

Write Reusable, Composable and Modular R Code

Michael Schubert

help function

<dl><dt>topic</dt>
<dd>either the fully-qualified name of the object or function to get
help for, in the format <code>module$function</code>; or a name that was exported
and attached from an imported module or package.</dd>
<dt>help_type</dt>
<dd>character string specifying the output format; currently,
only <code>'text'</code> is supported.</dd></dl>

Arguments

<code>box::help</code> displays help on a module’s objects and functions in much
the same way <code><a href='https://rdrr.io/r/utils/help.html'>help</a></code> does for package contents.

Display module documentation — help

<dl>

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


<dt>help_type</dt>
<dd>character string specifying the output format; currently,
only <code>'text'</code> is supported.</dd>

</dl>

help: Display module documentation

Description

Usage

Value

Arguments

Details