build

0th

Percentile

Build package.

Building converts a package source directory into a single bundled file. If binary = FALSE this creates a tar.gz package that can be installed on any platform, provided they have a full development environment (although packages without source code can typically be install out of the box). If binary = TRUE, the package will have a platform specific extension (e.g. .zip for windows), and will only be installable on the current platform, but no development environment is needed.

Usage
build(pkg = ".", path = NULL, binary = FALSE, vignettes = TRUE,
  manual = FALSE, args = NULL, quiet = FALSE)
Arguments
pkg

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

path

path in which to produce package. If NULL, defaults to the parent directory of the package.

binary

Produce a binary (--binary) or source ( --no-manual --no-resave-data) version of the package.

vignettes, manual

For source packages: if FALSE, don't build PDF vignettes (--no-build-vignettes) or manual (--no-manual).

args

An optional character vector of additional command line arguments to be passed to R CMD build if binary = FALSE, or R CMD install if binary = TRUE.

quiet

if TRUE suppresses output from this function.

Value

a string giving the location (including file name) of the built package

See Also

Other build functions: build_win

Aliases
  • build
Documentation reproduced from package devtools, version 1.13.5, License: GPL (>= 2)

Community examples

Looks like there are no examples yet.