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 installed 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(path = ".", dest_path = NULL, binary = FALSE, vignettes = TRUE,
  manual = FALSE, args = NULL, quiet = FALSE, needs_compilation = NA,
  compile_attributes = TRUE)
Arguments
path

Path to a package, or within a package.

dest_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.

needs_compilation

Usually only needed if the packages has C/C++/Fortran code. By default this is autodetected.

compile_attributes

if TRUE and the package uses Rcpp, call Rcpp::compileAttributes() before building the package. It is ignored if package does not need compilation.

Value

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

Aliases
  • build
Documentation reproduced from package pkgbuild, version 1.0.0, License: GPL-3

Community examples

Looks like there are no examples yet.