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.
build(path = ".", dest_path = NULL, binary = FALSE,
vignettes = TRUE, manual = FALSE, args = NULL, quiet = FALSE,
needs_compilation = pkg_has_src(path), compile_attributes = FALSE,
register_routines = FALSE)
Path to a package, or within a package.
path in which to produce package. If NULL
, defaults to
the parent directory of the package.
Produce a binary (--binary
) or source (
--no-manual --no-resave-data
) version of the package.
For source packages: if FALSE
, don't build PDF
vignettes (--no-build-vignettes
) or manual (--no-manual
).
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
.
if TRUE
suppresses output from this function.
Usually only needed if the packages has C/C++/Fortran code. By default this is autodetected.
if TRUE
and the package uses Rcpp, call
Rcpp::compileAttributes()
before building the package. It is ignored
if package does not need compilation.
if TRUE
and the package does not use Rcpp, call
register routines with
tools::package_native_routine_registration_skeleton()
before building
the package. It is ignored if package does not need compilation.
a string giving the location (including file name) of the built package