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.
roxygenize(package.dir = ".", roclets = NULL, load_code = NULL, clean = FALSE) roxygenise(package.dir = ".", roclets = NULL, load_code = NULL, clean = FALSE)
package.dir | Location of package top level directory. Default is working directory. |
---|---|
roclets | Character vector of roclet names to use with package.
The default, |
load_code | A function used to load all the R code in the package
directory. The default, |
clean | If |
NULL
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.