compileRdoc: Compiles the Rdoc help comments in a package

Description Usage Arguments Details Value Author(s) See Also

View source: R/compileRdoc.R

Description

Compiles the Rdoc help comments in a package by parsing the source code files and writes Rd help files.

Usage

1
compileRdoc(pkgname=NULL, path=pkgname, ..., verbose=TRUE)

Arguments

pkgname

A character string specifying the package name. If NULL, the package name is inferred from the DESCRIPTION file that is automatically search for in the subdirectories.

path

A character string specifying the path of the package source directory.

...

Additional arguments passed to Rdoc\$compile().

verbose

If TRUE, verbose output is printed, otherwise not.

Details

To compile all Rdoc comments in a package 'PkgA' that is located under the current working directory (e.g. PkgA/R/*.R) from the system command line, do:

1
2

Value

Returns nothing.

Author(s)

Henrik Bengtsson

See Also

See the Rdoc class.


R.oo documentation built on Aug. 26, 2020, 5:13 p.m.