Process a package with the Rd, namespace and collate rocletsSource:
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,
namespace_roclet(), and for
for more details.
roxygenize(package.dir = ".", roclets = NULL, load_code = NULL, clean = FALSE) roxygenise(package.dir = ".", roclets = NULL, load_code = NULL, clean = FALSE)
Location of package top level directory. Default is working directory.
Character vector of roclet names to use with package. The default,
NULL, uses the roxygen
rocletsoption, which defaults to
c("collate", "namespace", "rd").
A function used to load all the R code in the package directory. The default,
NULL, uses the strategy defined by the
loadroxygen option, which defaults to
load_pkgload(). See load for more details.
TRUE, roxygen will delete all files previously created by roxygen before running each roclet.
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.