SoDA (version 1.0-6.1)

promptAll: Create an outline of documentation for multiple objects

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().

Value

Nothing useful. Called for its side effect.

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.

See Also

packageAdd

Examples

# NOT RUN {
promptAll(objects(pattern="tri*"), "triDiagonal")
# }