compile.Rdoc {R.oo}R Documentation

Compile source code files containing Rdoc comments into Rd files

Description

Compile source code files containing Rdoc comments into Rd files.

Note, the class and methods to be compiled have to be loaded into R by for instance library() or source() before calling this method.

Usage

Rdoc$compile(filename=".*[.]R$", destPath=getManPath(this), showDeprecated=FALSE, verbose=FALSE, source=FALSE, check=TRUE, debug=FALSE, ...)

Arguments

filename The pathname or filename pattern of the Rdoc files to be compiled.
destPath The path where the generated Rd files should be saved.
showDeprecated If TRUE, Rd files are generated for deprecated objects too, otherwise not.
source If TRUE, the Rdoc files will be source()'ed first. This work of course only for Rdoc files that are R source files.
verbose If TRUE, detailed compilation information is printed.
debug If TRUE, extra debug information is printed.
... Not used.

Value

Returns nothing.

Author(s)

Henrik Bengtsson http://www.braju.com/R/

See Also

For more information see Rdoc.


[Package R.oo version 1.0.3 Index]