document: Use roxygen to document a package.

Description Usage Arguments See Also

View source: R/document.r

Description

This function is a wrapper for the roxygenize() function from the roxygen2 package. See the documentation and vignettes of that package to learn how to use roxygen.

Usage

1
document(pkg = ".", clean = NULL, roclets = NULL, reload = TRUE)

Arguments

pkg

package description, can be path or package name. See as.package for more information

clean, reload

Deprecated.

roclets

Character vector of roclet names to use with 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").

See Also

roxygenize, browseVignettes("roxygen2")


hadley/devtools documentation built on July 13, 2018, 9:13 a.m.