make.usage.section {mvbutils}R Documentation

Construct sections of documentation

Description

These are really intended for expediting documentation of large numbers of "internal" functions in a proto-package. make.usage.section and make.arguments.section form prototype USAGE and ARGUMENTS section for the specified functions. These are ready for pasting into flat-format documentation (and subsequent editing).

Usage

make.usage.section( funs=, file=stdout())
make.arguments.section( funs=, file=stdout())

Arguments

funs character vector, defaulting to find.funs() %except% find.documented( doctype="Rd")
file where to put the output ("clipboard" is useful)

Details

The default funs argument will find all functions not mentioned in flat-format ready-for-doc2Rd documentation. This is useful for documenting a group of "internal" functions.

make.usage.section simply puts the name of each function before its deparsed and concatenated argument list, one function per line.

make.arguments.section puts one argument per line, then a colon, then the name of the function in parentheses. The idea is that something about the argument should be added manually in a text editor.

Author(s)

Mark Bravington

See Also

flatdoc, formalize.package

Examples

make.usage.section( c( "make.usage.section", "find.funs")) # charvec returned invisibly
make.arguments.section( c( "make.usage.section", "find.funs")) # ditto

[Package Contents]