rdoc (version 0.1.0)

rdoc: Colourised R documentation

Description

Refer to colourised R docs as terminal output. Provides a replacement for help. A number of common (substantive) section accessors are also provided.

Usage

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)

Arguments

topic

character(1), help topic

package

character(1), package of help topic. Defaults to NULL

lib.loc

character(1), library location of package. Defaults to NULL

Details

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.

Examples

# NOT RUN {
library(rdoc)
rdoc("rdoc")
rdoc_examples("min")
rdoc_usage(substr)

# }