R: Automagically generates Rd documentation for functions

doc.gen {StabPerf}

R Documentation

Automagically generates Rd documentation for functions

Description

Checks the doc attribute of all functions defined in the global environment .GlobalEnv. Documentation is converted to Rd format (See doc2Rd) and written to a user-specified directory (default: man).

Usage

doc.gen(dir="man", all.names=TRUE)

Arguments

`dir`	character. Directory into which documentation files should be installed. Relative to current directory.
`all.names`	logical. Whether all functions (including those beginning with `.`) will be queried

Details

Does not check which functions belong to which packages. All functions which are visible are queried for a doc attribute and those which have one will have their documentation created and saved into an Rd file.

Value

NA on failure

Examples

doc.gen()

[Package StabPerf version 0.5 Index]