promptAll: Create an outline of documentation for multiple objects

In SoDA: Functions and Examples for "Software for Data Analysis"

Description

Documentation in outline form will be generated to document together all the objects (typically functions) whose names are given.

Usage

promptAll(objects, name, filename, where, ...)

Arguments

objects	The names of the objects to be documented.
name	The name for the documentation file; by default the name of the first of the objects is used.
filename	The file on which to save the outline of the documentation. By default, appends ".Rd" to name.
where	Optional environment where the objects will be found. By default, uses the top level environment of the call to promptAll().
...	Optional arguments to be passed on to prompt().

Details

The function prompt() is called for each of the objects. The usage and arguments sections of the individual documentation are merged. In particular, all shared argument names will be listed only once in the documentation shell.

Value

Nothing useful. Called for its side effect.

See Also

packageAdd

Examples

## Not run: 
promptAll(objects(pattern="tri*"), "triDiagonal")

## End(Not run)

SoDA documentation built on Oct. 28, 2020, 9:07 a.m.