Description Usage Arguments Details Examples
Refer to colourised R docs as terminal output. Provides a replacement for
help
. A number of common (substantive) section accessors are also
provided.
1 2 3 4 5 6 7 8 9 | rdoc(topic, package = NULL, lib.loc = NULL)
rdoc_usage(topic, package = NULL, lib.loc = NULL)
rdoc_arguments(topic, package = NULL, lib.loc = NULL)
rdoc_details(topic, package = NULL, lib.loc = NULL)
rdoc_examples(topic, package = NULL, lib.loc = NULL)
|
topic |
|
package |
|
lib.loc |
|
The manner in which content is outputted depends on where it is
being used. If used from a terminal the contents will be outputted via
file.show
. Otherwise the output will be printed interactively by
sections unless this has been disabled via options(rdoc.by_section =
FALSE)
. When printing by section pressing the <enter> keypress will show
the next section. Any other keypress will exit the interaction without
printing any remaining sections. Color support is checked via
crayon::has_color()
. Customising rdoc output is possible via
'options', see rdoc_options
for more details.
1 2 3 4 | library(rdoc)
rdoc("rdoc")
rdoc_examples("min")
rdoc_usage(substr)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.