help2: Return help for topic

In toscm/toscutil: Utility Functions

Return help for topic

Description

Returns the help text for the specified topic formatted either as plain text, html or latex.

Usage

help2(topic, format = "text", package = NULL)

Arguments

topic	character, the topic for which to return the help text. See argument topic of function help() for details.
format	character, either "text", "html" or "latex"
package	character, the package for which to return the help text. This argument will be ignored if topic is specified. Package must be attached to the search list first, e.g. by calling library(package).

Value

The help text for the specified topic in the specified format as string.

Examples

htm <- help2("sum", "html")
txt <- help2(topic = "sum", format = "text")
cat2(txt)

toscm/toscutil documentation built on Feb. 23, 2025, 2:20 p.m.