[ top | up ]

Produce prototype of a help()-file

Syntax

prompt(object=, filename=)

prompt.default(object,
    filename = paste(name, ".man", sep = ""),
    force.function = FALSE)

Arguments

object (typically) an R function
filename name of the output file
force.function treat object as function in any case

Description

The main goal is to facilitate the constructing of help() files for function documentation. An ASCII file filename is produced containing the proper function and argument names of object. You have to edit it before adding the documentation to the source tree, i.e. (currently) to $RHOME/src/library/base/man/.

See Also

help and the documentation about writing help-files, currently in the file $RHOME/mansrc/ABOUT.tex.

Examples

prompt(plot.default) prompt(interactive, force.f=TRUE)