Learn R Programming
roxygen2 (version 3.1.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 for update_collate, for more details.

Usage

roxygenize(package.dir = ".", roxygen.dir = package.dir,
  copy.package = package.dir != roxygen.dir, overwrite = TRUE,
  unlink.target = FALSE, roclets = NULL, load_code = source_package)
roxygenise(package.dir = ".", roxygen.dir = package.dir,
  copy.package = package.dir != roxygen.dir, overwrite = TRUE,
  unlink.target = FALSE, roclets = NULL, load_code = source_package)

Arguments

package.dir
the package's top directory
roxygen.dir,copy.package,overwrite,unlink.target
deprecated
roclets
character vector of roclet names to apply to package. This defaults to NULL, which will use the roclets fields in the list provided in the Roxygen DESCRIPTION field. If none are specified, defaults to c("collate", "namespace", "rd").
load_code
A function used to load all the R code in the package directory. It is called with the path to the package, and it should return an environment containing all the sourced code.

Value

NULL