EVOLUTION-MANAGER

Edit File: install.packages.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Install Packages from Repositories or Local Files</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" type="text/css" href="R.css" />
</head><body>

<table width="100%" summary="page for install.packages {utils}"><tr><td>install.packages {utils}</td><td style="text-align: right;">R Documentation</td></tr></table>

<h2>Install Packages from Repositories or Local Files</h2>

<h3>Description</h3>

Download and install packages from CRAN-like repositories or from
local files.

<h3>Usage</h3>

<pre>
install.packages(pkgs, lib, repos = getOption("repos"),
 contriburl = contrib.url(repos, type),
 method, available = NULL, destdir = NULL,
 dependencies = NA, type = getOption("pkgType"),
 configure.args = getOption("configure.args"),
 configure.vars = getOption("configure.vars"),
 clean = FALSE, Ncpus = getOption("Ncpus", 1L),
 verbose = getOption("verbose"),
 libs_only = FALSE, INSTALL_opts, quiet = FALSE,
 keep_outputs = FALSE, ...)
</pre>

<h3>Arguments</h3>

<table summary="R argblock">
<tr valign="top"><td><code>pkgs</code></td>
<td>
character vector of the names of packages whose
current versions should be downloaded from the repositories.

If <code>repos = NULL</code>, a character vector of file paths,

<dl>
<dt>on windows,</dt><dd>
file paths of &lsquo;.zip&rsquo; files containing binary builds of
packages. (<code>http://</code> and <code>file://</code> URLs are also accepted
and the files will be downloaded and installed from local copies.)
Source directories or file paths or URLs of archives may be
specified with <code>type = "source"</code>, but some packages need
suitable tools installed (see the &lsquo;Details&rsquo; section).

</dd>
<dt>On Unix-alikes,</dt><dd>these file paths can be source directories or archives
or binary package archive files (as created by <code>R CMD build
 --binary</code>). (<code>http://</code> and <code>file://</code> URLs are also
accepted and the files will be downloaded and installed from local
copies.) On a CRAN build of R for macOS these can be &lsquo;.tgz&rsquo;
files containing binary package archives.
Tilde-expansion will be done on file paths.

</dd>
</dl>

If this is missing, a listbox of
available packages is presented where possible in an interactive R
session.

</td></tr>
<tr valign="top"><td><code>lib</code></td>
<td>

character vector giving the library directories where to
install the packages. Recycled as needed. If missing, defaults to
the first element of <code><a href="../../base/html/libPaths.html">.libPaths</a>()</code>.

</td></tr>
<tr valign="top"><td><code>repos</code></td>
<td>

character vector, the base URL(s) of the repositories
to use, e.g., the URL of a CRAN mirror such as
<code>"https://cloud.r-project.org"</code>. For more details on
supported URL schemes see <code><a href="../../base/html/connections.html">url</a></code>.

Can be <code>NULL</code> to install from local files, directories or URLs:
this will be inferred by extension from <code>pkgs</code> if of length one.

</td></tr>
<tr valign="top"><td><code>contriburl</code></td>
<td>

URL(s) of the contrib sections of the repositories. Use this
argument if your repository mirror is incomplete, e.g., because
you burned only the &lsquo;contrib&rsquo; section on a CD, or only have
binary packages. Overrides argument <code>repos</code>.
Incompatible with <code>type = "both"</code>.

</td></tr>
<tr valign="top"><td><code>method</code></td>
<td>

download method, see <code><a href="download.file.html">download.file</a></code>. Unused if
a non-<code>NULL</code> <code>available</code> is supplied.

</td></tr>
<tr valign="top"><td><code>available</code></td>
<td>

a matrix as returned by <code><a href="available.packages.html">available.packages</a></code>
listing packages available at the repositories, or <code>NULL</code> when
the function makes an internal call to <code>available.packages</code>.
Incompatible with <code>type = "both"</code>.

</td></tr>
<tr valign="top"><td><code>destdir</code></td>
<td>

directory where downloaded packages are stored. If it is
<code>NULL</code> (the default) a subdirectory
<code>downloaded_packages</code> of the session temporary
directory will be used (and the files will be deleted
at the end of the session).

</td></tr>
<tr valign="top"><td><code>dependencies</code></td>
<td>
logical indicating whether to also install
uninstalled packages which these packages depend on/link
to/import/suggest (and so on recursively).
Not used if <code>repos = NULL</code>.
Can also be a character vector, a subset of
<code>c("Depends", "Imports", "LinkingTo", "Suggests", "Enhances")</code>.

Only supported if <code>lib</code> is of length one (or missing),
so it is unambiguous where to install the dependent packages. If
this is not the case it is ignored, with a warning.

The default, <code>NA</code>, means
<code>c("Depends", "Imports", "LinkingTo")</code>.

<code>TRUE</code> means to use
<code>c("Depends", "Imports", "LinkingTo", "Suggests")</code> for
<code>pkgs</code> and
<code>c("Depends", "Imports", "LinkingTo")</code> for added dependencies:
this installs all the packages needed to run <code>pkgs</code>, their
examples, tests and vignettes (if the package author specified them
correctly).

In all of these, <code>"LinkingTo"</code> is omitted for binary packages.

</td></tr>
<tr valign="top"><td><code>type</code></td>
<td>
character, indicating the type of package to download and
install. Will be <code>"source"</code> except on Windows and some macOS
builds: see the section on &lsquo;Binary packages&rsquo; for those.

</td></tr>
<tr valign="top"><td><code>configure.args</code></td>
<td>

(Used only for source installs.) A character vector or a named list.
If a character vector with no names is supplied, the elements are
concatenated into a single string (separated by a space) and used as
the value for the --configure-args flag in the call to
<code>R CMD INSTALL</code>. If the character vector has names these
are assumed to identify values for --configure-args for
individual packages. This allows one to specify settings for an
entire collection of packages which will be used if any of those
packages are to be installed. (These settings can therefore be
re-used and act as default settings.)

A named list can be used also to the same effect, and that
allows multi-element character strings for each package
which are concatenated to a single string to be used as the
value for --configure-args.

</td></tr>
<tr valign="top"><td><code>configure.vars</code></td>
<td>

(Used only for source installs.) Analogous to <code>configure.args</code>
for flag --configure-vars, which is used to set environment
variables for the <code>configure</code> run.

</td></tr>
<tr valign="top"><td><code>clean</code></td>
<td>
a logical value indicating whether to add the
--clean flag to the call to <code>R CMD INSTALL</code>.
This is sometimes used to perform additional operations at the end
of the package installation in addition to removing intermediate files.

</td></tr>
<tr valign="top"><td><code>Ncpus</code></td>
<td>
the number of parallel processes to use for a parallel
install of more than one source package. Values greater than one
are supported if the <code>make</code> command specified by
<code>Sys.getenv("MAKE", "make")</code> accepts argument
<code>-k -j <var>Ncpus</var></code>.

</td></tr>
<tr valign="top"><td><code>verbose</code></td>
<td>

a logical indicating if some &ldquo;progress report&rdquo; should be given.

</td></tr>
<tr valign="top"><td><code>libs_only</code></td>
<td>

a logical value: should the --libs-only option be used to
install only additional sub-architectures for source installs? (See also
<code>INSTALL_opts</code>.) This can also be used on Windows to install
just the DLL(s) from a binary package, e.g. to add 64-bit
DLLs to a 32-bit install.

</td></tr>
<tr valign="top"><td><code>INSTALL_opts</code></td>
<td>

an optional character vector of additional option(s) to be passed to
<code>R CMD INSTALL</code> for a source package install. E.g.,
<code>c("--html", "--no-multiarch", "--no-test-load")</code>.

Can also be a named list of character vectors to be used as
additional options, with names the respective package names.

</td></tr>
<tr valign="top"><td><code>quiet</code></td>
<td>

logical: if true, reduce the amount of output.

</td></tr>
<tr valign="top"><td><code>keep_outputs</code></td>
<td>

a logical: if true, keep the outputs from installing source packages
in the current working directory, with the names of the output files
the package names with &lsquo;.out&rsquo; appended. Alternatively, a
character string giving the directory in which to save the outputs.
Ignored when installing from local files.

</td></tr>
<tr valign="top"><td><code>...</code></td>
<td>

Arguments to be passed to <code><a href="download.file.html">download.file</a></code> or to the
functions for binary installs on macOS and Windows (which accept
an argument <code>"lock"</code>: see the section on &lsquo;Locking&rsquo;).

</td></tr>
</table>

<h3>Details</h3>

This is the main function to install packages. It takes a vector of
names and a destination library, downloads the packages from the
repositories and installs them. (If the library is omitted it
defaults to the first directory in <code>.libPaths()</code>, with a message
if there is more than one.) If <code>lib</code> is omitted or is of length
one and is not a (group) writable directory, in interactive use the
code offers to create a personal library tree (the first element of
<code>Sys.getenv("R_LIBS_USER")</code>) and install there.

Detection of a writable directory is problematic on Windows: see the
&lsquo;Note&rsquo; section.

For installs from a repository an attempt is made to install the
packages in an order that respects their dependencies. This does
assume that all the entries in <code>lib</code> are on the default library
path for installs (set by environment variable R_LIBS).

You are advised to run <code>update.packages</code> before
<code>install.packages</code> to ensure that any already installed
dependencies have their latest versions.

<h3>Value</h3>

Invisible <code>NULL</code>.

<h3>Binary packages</h3>

This section applies only to platforms where binary packages are
available: Windows and CRAN builds for macOS.

R packages are primarily distributed as source packages, but
binary packages (a packaging up of the installed package) are
also supported, and the type most commonly used on Windows and by the
CRAN builds for macOS. This function can install either type, either by
downloading a file from a repository or from a local file.

Possible values of <code>type</code> are (currently) <code>"source"</code>,
<code>"mac.binary"</code>, <code>"mac.binary.el-capitan"</code> and
<code>"win.binary"</code>: the appropriate binary type where supported can
also be selected as <code>"binary"</code>.

For a binary install from a repository, the function checks for the
availability of a source package on the same repository, and reports
if the source package has a later version, or is available but no
binary version is. This check can be suppressed by using

<pre> options(install.packages.check.source = "no")</pre>
and should be if there is a partial repository containing only binary
files.

An alternative (and the current default) is <code>"both"</code> which means
&lsquo;use binary if available and current, otherwise try
source&rsquo;. The action if there are source packages which are preferred
but may contain code which needs to be compiled is controlled by
<code><a href="../../base/html/options.html">getOption</a>("install.packages.compile.from.source")</code>.
<code>type = "both"</code> will be silently changed to <code>"binary"</code> if
either <code>contriburl</code> or <code>available</code> is specified.

Using packages with <code>type = "source"</code> always works provided the
package contains no C/C++/Fortran code that needs compilation.
Otherwise,

<dl>
<dt>on Windows</dt><dd>you will need to have installed the Rtools
collection as described in the &lsquo;R for Windows FAQ&rsquo; and
you must have the PATH environment variable set up as required
by Rtools.

For a 32/64-bit installation of R on Windows, a small minority of
packages with compiled code need either <code>INSTALL_opts =
 "--force-biarch"</code> or <code>INSTALL_opts = "--merge-multiarch"</code> for a
source installation. (It is safe to always set the latter when
installing from a repository or tarballs, although it will be a little
slower.)

When installing a binary package, <code>install.packages</code> will abort
the install if it detects that the package is already installed and is
currently in use. In some circumstances (e.g., multiple instances of
R running at the same time and sharing a library) it will not detect a
problem, but the installation may fail as Windows locks files in use.

</dd>
<dt>On Unix-alikes,</dt><dd>when the package contains C/C++/Fortran code
that needs compilation, on macOS you need to have installed the
&lsquo;Command-line tools for Xcode&rsquo; (see the &lsquo;R Installation
and Administration Manual&rsquo;) and if needed by the package a Fortran
compiler, and have them in your path.

</dd>
</dl>

<h3>Locking</h3>

There are various options for locking: these differ between source and
binary installs.

By default for a source install, the library directory is
&lsquo;locked&rsquo; by creating a directory &lsquo;00LOCK&rsquo; within it. This
has two purposes: it prevents any other process installing into that
library concurrently, and is used to store any previous version of the
package to restore on error. A finer-grained locking is provided by
the option --pkglock which creates a separate lock for each
package: this allows enough freedom for parallel
installation. Per-package locking is the default when installing a
single package, and for multiple packages when <code>Ncpus &gt; 1L</code>.
Finally locking (and restoration on error) can be suppressed by
--no-lock.

For a macOS or Windows binary install, no locking is done by
default. Setting argument <code>lock</code> to <code>TRUE</code> (it defaults to
the value of <code><a href="../../base/html/options.html">getOption</a>("install.lock", FALSE)</code>) will use
per-directory locking as described for source installs: if the value
is <code>"pkglock"</code> per-package locking will be used.

If package locking is used on Windows with <code>libs_only = TRUE</code> and
the installation fails, the package will be restored to its previous
state.

Note that it is possible for the package installation to fail so badly
that the lock directory is not removed: this inhibits any further
installs to the library directory (or for <code>--pkglock</code>, of the
package) until the lock directory is removed manually.

<h3>Parallel installs</h3>

Parallel installs are attempted if <code>pkgs</code> has length greater than
one and <code>Ncpus &gt; 1</code>. It makes use of a parallel <code>make</code>,
so the <code>make</code> specified (default <code>make</code>) when R was
built must be capable of supporting <code>make -j <var>n</var></code>: GNU make,
<code>dmake</code> and <code>pmake</code> do, but Solaris <code>make</code> and
older FreeBSD <code>make</code> do not: if necessary environment variable
MAKE can be set for the current session to select a suitable
<code>make</code>.

<code>install.packages</code> needs to be able to compute all the
dependencies of <code>pkgs</code> from <code>available</code>, including if one
element of <code>pkgs</code> depends indirectly on another. This means that
if for example you are installing <acronym>CRAN</acronym> packages which depend
on Bioconductor packages which in turn depend on <acronym>CRAN</acronym>
packages, <code>available</code> needs to cover both <acronym>CRAN</acronym> and
Bioconductor packages.

<h3>Timeouts</h3>

A limit on the elapsed time for each call to <code>R CMD INSTALL</code>
(so for source installs) can be set via environment variable
_R_INSTALL_PACKAGES_ELAPSED_TIMEOUT_: in seconds (or in minutes
or hours with optional suffix m or h, suffix s
being allowed for the default seconds) with <code>0</code> meaning no limit.

For non-parallel installs this is implemented via the
<code>timeout</code> argument of <code><a href="../../base/html/system2.html">system2</a></code>: for parallel
installs via the OS's <code>timeout</code> command. (The one
tested is from GNU coreutils, commonly available on Linux but
not other Unix-alikes. If no such command is available the timeout
request is ignored, with a warning.) For parallel installs a
Error 124 message from <code>make</code> indicates that timeout
occurred.

Timeouts during installation might leave lock directories behind and
not restore previous versions.

<dl>
<dt>On Unix-alikes:</dt><dd>
Some binary distributions of R have <code>INSTALL</code> in a separate
bundle, e.g. an <code>R-devel</code> RPM. <code>install.packages</code> will
give an error if called with <code>type = "source"</code> on such a system.

Some binary Linux distributions of R can be installed on a machine
without the tools needed to install packages: a possible remedy is to
do a complete install of R which should bring in all those tools as
dependencies.

</dd>
<dt>On Windows:</dt><dd>
<code>install.packages</code> tries to detect if you have write permission
on the library directories specified, but Windows reports unreliably.
If there is only one library directory (the default), R tries to
find out by creating a test directory, but even this need not be the
whole story: you may have permission to write in a library directory
but lack permission to write binary files (such as &lsquo;.dll&rsquo; files)
there. See the &lsquo;R for Windows FAQ&rsquo; for workarounds.

</dd>
</dl>

<code><a href="update.packages.html">update.packages</a></code>,
<code><a href="available.packages.html">available.packages</a></code>,
<code><a href="download.packages.html">download.packages</a></code>,
<code><a href="installed.packages.html">installed.packages</a></code>,
<code><a href="contrib.url.html">contrib.url</a></code>.

See <code><a href="download.file.html">download.file</a></code> for how to handle proxies and
other options to monitor file transfers.

<code><a href="untar.html">untar</a></code> for manually unpacking source package tarballs.

<code><a href="INSTALL.html">INSTALL</a></code>, <code><a href="REMOVE.html">REMOVE</a></code>, <code><a href="remove.packages.html">remove.packages</a></code>,
<code><a href="../../base/html/library.html">library</a></code>, <code><a href="../../base/html/zpackages.html">.packages</a></code>, <code><a href="../../base/html/dcf.html">read.dcf</a></code>

The &lsquo;R Installation and Administration&rsquo; manual for how to
set up a repository.

<h3>Examples</h3>

<pre>## Not run: 
## A Linux example for Fedora's layout of udunits2 headers.
install.packages(c("ncdf4", "RNetCDF"),
 configure.args = c(RNetCDF = "--with-netcdf-include=/usr/include/udunits2"))

## End(Not run)</pre>

<hr /><div style="text-align: center;">[Package utils version 3.6.0 <a href="00Index.html">Index</a>]</div>
</body></html>