1% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/install-local.R
3\name{install_local}
4\alias{install_local}
5\title{Install a package from a local file}
6\usage{
7install_local(
8  path = ".",
9  subdir = NULL,
10  dependencies = NA,
11  upgrade = c("default", "ask", "always", "never"),
12  force = FALSE,
13  quiet = FALSE,
14  build = !is_binary_pkg(path),
15  build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"),
16  build_manual = FALSE,
17  build_vignettes = FALSE,
18  repos = getOption("repos"),
19  type = getOption("pkgType"),
20  ...
21)
22}
23\arguments{
24\item{path}{path to local directory, or compressed file (tar, zip, tar.gz
25tar.bz2, tgz2 or tbz)}
26
27\item{subdir}{subdirectory within url bundle that contains the R package.}
28
29\item{dependencies}{Which dependencies do you want to check?
30Can be a character vector (selecting from "Depends", "Imports",
31"LinkingTo", "Suggests", or "Enhances"), or a logical vector.
32
33\code{TRUE} is shorthand for "Depends", "Imports", "LinkingTo" and
34"Suggests". \code{NA} is shorthand for "Depends", "Imports" and "LinkingTo"
35and is the default. \code{FALSE} is shorthand for no dependencies (i.e.
36just check this package, not its dependencies).
37
38The value "soft" means the same as \code{TRUE}, "hard" means the same as \code{NA}.
39
40You can also specify dependencies from one or more additional fields,
41common ones include:
42\itemize{
43\item Config/Needs/website - for dependencies used in building the pkgdown site.
44\item Config/Needs/coverage for dependencies used in calculating test coverage.
45}}
46
47\item{upgrade}{Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"
48respects the value of the \code{R_REMOTES_UPGRADE} environment variable if set,
49and falls back to "ask" if unset. "ask" prompts the user for which out of
50date packages to upgrade. For non-interactive sessions "ask" is equivalent
51to "always". \code{TRUE} and \code{FALSE} are also accepted and correspond to
52"always" and "never" respectively.}
53
54\item{force}{Force installation, even if the remote state has not changed
55since the previous install.}
56
57\item{quiet}{If \code{TRUE}, suppress output.}
58
59\item{build}{If \code{TRUE} build the package before installing.}
60
61\item{build_opts}{Options to pass to \verb{R CMD build}, only used when \code{build} is \code{TRUE}.}
62
63\item{build_manual}{If \code{FALSE}, don't build PDF manual ('--no-manual').}
64
65\item{build_vignettes}{If \code{FALSE}, don't build package vignettes ('--no-build-vignettes').}
66
67\item{repos}{A character vector giving repositories to use.}
68
69\item{type}{Type of package to \code{update}.}
70
71\item{...}{Other arguments passed on to \code{\link[utils:install.packages]{utils::install.packages()}}.}
72}
73\description{
74This function is vectorised so you can install multiple packages in
75a single command.
76}
77\examples{
78\dontrun{
79dir <- tempfile()
80dir.create(dir)
81pkg <- download.packages("testthat", dir, type = "source")
82install_local(pkg[, 2])
83}
84}
85\seealso{
86Other package installation:
87\code{\link{install_bioc}()},
88\code{\link{install_bitbucket}()},
89\code{\link{install_cran}()},
90\code{\link{install_dev}()},
91\code{\link{install_github}()},
92\code{\link{install_gitlab}()},
93\code{\link{install_git}()},
94\code{\link{install_svn}()},
95\code{\link{install_url}()},
96\code{\link{install_version}()}
97}
98\concept{package installation}
99