install_local: Install a package from a local file

In remotes: R Package Installation from Remote Repositories, Including 'GitHub'

Install a package from a local file

Description

This function is vectorised so you can install multiple packages in a single command.

Usage

install_local(
  path = ".",
  subdir = NULL,
  dependencies = NA,
  upgrade = c("default", "ask", "always", "never"),
  force = FALSE,
  quiet = FALSE,
  build = !is_binary_pkg(path),
  build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"),
  build_manual = FALSE,
  build_vignettes = FALSE,
  repos = getOption("repos"),
  type = getOption("pkgType"),
  ...
)

Arguments

path	path to local directory, or compressed file (tar, zip, tar.gz tar.bz2, tgz2 or tbz)
subdir	subdirectory within url bundle that contains the R package.
dependencies	Which dependencies do you want to check? Can be a character vector (selecting from "Depends", "Imports", "LinkingTo", "Suggests", or "Enhances"), or a logical vector. TRUE is shorthand for "Depends", "Imports", "LinkingTo" and "Suggests". NA is shorthand for "Depends", "Imports" and "LinkingTo" and is the default. FALSE is shorthand for no dependencies (i.e. just check this package, not its dependencies). The value "soft" means the same as TRUE, "hard" means the same as NA. You can also specify dependencies from one or more additional fields, common ones include: Config/Needs/website - for dependencies used in building the pkgdown site. Config/Needs/coverage for dependencies used in calculating test coverage.
upgrade	Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default" respects the value of the R_REMOTES_UPGRADE environment variable if set, and falls back to "ask" if unset. "ask" prompts the user for which out of date packages to upgrade. For non-interactive sessions "ask" is equivalent to "always". TRUE and FALSE are also accepted and correspond to "always" and "never" respectively.
force	Force installation, even if the remote state has not changed since the previous install.
quiet	If TRUE, suppress output.
build	If TRUE build the package before installing.
build_opts	Options to pass to ⁠R CMD build⁠, only used when build is TRUE.
build_manual	If FALSE, don't build PDF manual ('–no-manual').
build_vignettes	If FALSE, don't build package vignettes ('–no-build-vignettes').
repos	A character vector giving repositories to use.
type	Type of package to update.
...	Other arguments passed on to utils::install.packages().

See Also

Other package installation: install_bioc(), install_bitbucket(), install_cran(), install_dev(), install_github(), install_gitlab(), install_git(), install_svn(), install_url(), install_version()

Examples

## Not run: 
dir <- tempfile()
dir.create(dir)
pkg <- download.packages("testthat", dir, type = "source")
install_local(pkg[, 2])

## End(Not run)

remotes documentation built on May 29, 2024, 7:51 a.m.