roxygen2 (version 2.0)

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

Description

This is the workhorse function that uses roclets, the built-in document tranformation functions, to build all documentation for a package. See the documentation for the individual roclets, rd_roclet, namespace_roclet and collate_roclet, for documentation on how to use each one.

Usage

roxygenize(package.dir, roxygen.dir = package.dir,
  copy.package = package.dir != roxygen.dir, overwrite =
  TRUE, unlink.target = FALSE, roclets = c("collate",
  "namespace", "rd"))
  roxygenise(package.dir, roxygen.dir = package.dir,
  copy.package = package.dir != roxygen.dir, overwrite =
  TRUE, unlink.target = FALSE, roclets = c("collate",
  "namespace", "rd"))

Arguments

package.dir

the package's top directory

roxygen.dir

where to create roxygen output; defaults to package.roxygen.

copy.package

copies the package over before adding/manipulating files.

overwrite

overwrite target files?

unlink.target

unlink target directory before processing files?

roclets

character vector of roclet names to apply to package

Value

• NULL