roxygen_and_build {Rd2roxygen}R Documentation

Roxygenize a package, clean up and build/check the package

Description

After the source package is roxygenized, this function will build the package. Optionally it also installs or checks the package, reformats the code in the usage and examples sections. Note rab is an alias of roxygen_and_build.

Usage

roxygen_and_build(pkg, build = TRUE, build.opts = "--no-manual", install = FALSE, 
    check = FALSE, check.opts = "--as-cran --no-manual", remove.check = TRUE, 
    reformat = TRUE, ...)

rab(pkg, build = TRUE, build.opts = "--no-manual", install = FALSE, check = FALSE, 
    check.opts = "--as-cran --no-manual", remove.check = TRUE, reformat = TRUE, 
    ...)

Arguments

pkg

the root directory of the source package

build

whether to build the package

build.opts

options to be passed to R CMD build

install

whether to install the package

check

whether to check the package

check.opts

options to check the package (e.g. "--no-examples")

remove.check

whether to remove the directory generated by R CMD check

reformat

whether to reformat the usage and examples code; see reformat_code

...

other arguments passed to roxygenize

Value

NULL

Author(s)

Yihui Xie <http://yihui.name>

Examples

## Not run: 
roxygen_and_build("Rd2roxygen", install = TRUE)
## or simply
rab("Rd2roxygen", install = TRUE)

## End(Not run)

[Package Rd2roxygen version 1.4.2 Index]