roxygenize {roxygen} R Documentation

Process a package with the Rd, namespace and collate roclets.

Description


This is the workhorse function that uses roclets, the built-in document
transformation functions, to build all documentation for a package.
See the documentation for the individual roclets, rd_roclet(),
namespace_roclet(), and for update_collate(), for more details.

Usage

roxygenize(package.dir);

Arguments

package.dir

Location of package top level directory. Default is working directory. [as string]

Details

Note that roxygen2 is a dynamic documentation system: it works by inspecting loaded objects in the package. This means that you must be able to load the package in order to document it: see load for details.

Authors

roxygenNet

Value

a tuple list of the R function documentation symbols data

clr value class

Examples


[Package roxygen version 1.0.0.0 Index]