install: Install a local development package.

In rstudio/packrat: A Dependency Management System for Projects and their R Package Dependencies

Install a local development package.

Description

Uses R CMD INSTALL to install the package. Will also try to install dependencies of the package from CRAN, if they're not already installed.

Usage

install(
  pkg = ".",
  reload = TRUE,
  quick = FALSE,
  local = TRUE,
  args = getOption("devtools.install.args"),
  quiet = FALSE,
  dependencies = NA,
  build_vignettes = !quick,
  keep_source = getOption("keep.source.pkgs")
)

Arguments

pkg	package description, can be path or package name.
reload	if TRUE (the default), will automatically reload the package after installing.
quick	if TRUE skips docs, multiple-architectures, demos, and vignettes, to make installation as fast as possible.
local	if FALSE builds the package first: this ensures that the installation is completely clean, and prevents any binary artefacts (like ‘.o’, .so) from appearing in your local package directory, but is considerably slower, because every compile has to start from scratch.
args	An optional character vector of additional command line arguments to be passed to R CMD install. This defaults to the value of the option "devtools.install.args".
quiet	if TRUE suppresses output from this function.
dependencies	logical indicating to also install uninstalled packages which this pkg depends on/links to/suggests. See argument dependencies of install.packages.
build_vignettes	if TRUE, will build vignettes. Normally it is build that's responsible for creating vignettes; this argument makes sure vignettes are built even if a build never happens (i.e. because local = TRUE.
keep_source	If TRUE will keep the srcrefs from an installed package. This is useful for debugging (especially inside of RStudio). It defaults to the option "keep.source.pkgs".

Details

By default, installation takes place using the current package directory. If you have compiled code, this means that artefacts of compilation will be created in the src/ directory. If you want to avoid this, you can use local = FALSE to first build a package bundle and then install it from a temporary directory. This is slower, but keeps the source directory pristine.

If the package is loaded, it will be reloaded after installation.

rstudio/packrat documentation built on Feb. 5, 2024, 9:17 p.m.