EVOLUTION-MANAGER

Edit File: INSTALL.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 Add-on Packages</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 {utils}"><tr><td>INSTALL {utils}</td><td style="text-align: right;">R Documentation</td></tr></table>

<h2>Install Add-on Packages</h2>

<h3>Description</h3>

Utility for installing add-on packages.

<h3>Usage</h3>

<pre>
R CMD INSTALL [options] [-l lib] pkgs
</pre>

<h3>Arguments</h3>

<table summary="R argblock">
<tr valign="top"><td><code>pkgs</code></td>
<td>
a space-separated list with the path names of the packages to be
installed. See &lsquo;Details&rsquo;.
</td></tr>
<tr valign="top"><td><code>lib</code></td>
<td>
the path name of the R library tree to install to. Also
accepted in the form --library=lib. Paths including spaces should
be quoted, using the conventions for the shell in use.
</td></tr>
<tr valign="top"><td><code>options</code></td>
<td>
a space-separated list of options through which in
particular the process for building the help files can be controlled.
Use <code>R CMD INSTALL --help</code> for the full current list of options.
</td></tr>
</table>

<h3>Details</h3>

This will stop at the first error, so if you want all the <code>pkgs</code>
to be tried, call this via a shell loop.

If used as <code>R CMD INSTALL pkgs</code> without explicitly specifying
<code>lib</code>, packages are installed into the library tree rooted at the
first directory in the library path which would be used by R run in
the current environment.

To install into the library tree <code><var>lib</var></code>, use
<code>R CMD INSTALL -l <var>lib</var> <var>pkgs</var></code>.
This prepends <code>lib</code> to the library path for
duration of the install, so required packages in the installation
directory will be found (and used in preference to those in other
libraries).

Both <code>lib</code> and the elements of <code>pkgs</code> may be absolute or
relative path names of directories. <code>pkgs</code> may also contain
names of package archive files: these are then extracted to a
temporary directory. These are tarballs containing a single
directory, optionally compressed by <code>gzip</code>, <code>bzip2</code>,
<code>xz</code> or <code>compress</code>.
Finally, binary package archive files (as created by
<code>R CMD INSTALL --build</code>) can be supplied.

Tarballs are by default unpackaged by the internal <code><a href="untar.html">untar</a></code>
function: if needed an external <code>tar</code> command can be specified
by the environment variable R_INSTALL_TAR: please ensure that it
can handle the type of compression used on the tarball. (This is
sometimes needed for tarballs containing invalid or unsupported
sections, and can be faster on very large tarballs. Setting
R_INSTALL_TAR to tar.exe has been needed to overcome
permissions issues on some Windows systems.)

The package sources can be cleaned up prior to installation by
--preclean or after by --clean: cleaning is
essential if the sources are to be used with more than one
architecture or platform.

Some package sources contain a &lsquo;configure&rsquo; script that can be
passed arguments or variables via the option --configure-args
and --configure-vars, respectively, if necessary. The latter
is useful in particular if libraries or header files needed for the
package are in non-system directories. In this case, one can use the
configure variables <code>LIBS</code> and <code>CPPFLAGS</code> to specify these
locations (and set these via --configure-vars), see section
&ldquo;Configuration variables&rdquo; in &ldquo;R Installation and
Administration&rdquo; for more information. (If these are used more than
once on the command line they are concatenated.) The configure
mechanism can be bypassed using the option --no-configure.

If the attempt to install the package fails, leftovers are removed.
If the package was already installed, the old version is restored.
This happens either if a command encounters an error or if the
install is interrupted from the keyboard: after cleaning up the script
terminates.

For details of the locking which is done, see the section
&lsquo;Locking&rsquo; in the help for <code><a href="install.packages.html">install.packages</a></code>.

Option --build can be used to tar up the installed package
for distribution as a binary package (as used on macOS). This is done
by <code>utils::tar</code> unless environment variable R_INSTALL_TAR
is set.

By default a package is installed with static HTML help pages if and
only if R was: use options --html and --no-html to
override this.

Packages are not by default installed keeping the source formatting
(see the <code>keep.source</code> argument to <code><a href="../../base/html/source.html">source</a></code>): this
can be enabled by the option --with-keep.source or by setting
environment variable R_KEEP_PKG_SOURCE to <code>yes</code>.

Use <code>R CMD INSTALL --help</code> for concise usage information,
including all the available options.

<h3>Sub-architectures</h3>

An R installation can support more than one sub-architecture:
currently this is most commonly used for 32- and 64-bit builds on
Windows.

For such installations, the default behaviour is to try to install
source packages for all installed sub-architectures unless the package
has a configure script or a &lsquo;src/Makefile&rsquo; (or
&lsquo;src/Makefile.win&rsquo; on Windows), when only compiled code for the
sub-architecture running <code>R CMD INSTALL</code> is installed.

To install a source package with compiled code only for the
sub-architecture used by <code>R CMD INSTALL</code>, use
--no-multiarch. To install just the compiled code for
another sub-architecture, use --libs-only.

There are two ways to install for all available sub-architectures. If
the configure script is known to work for both Windows architectures,
use flag --force-biarch (and packages can specify this
via a Biarch: yes field in their <code>DESCRIPTION</code> files).
Second, a single tarball can be installed with

<pre>R CMD INSTALL --merge-multiarch mypkg_version.tar.gz</pre>

<h3>Staged installation</h3>

The default way to install source packages changed in R 3.6.0, so
packages are first installed to a temporary location and then (if
successful) moved to the destination library directory. Some older
packages were written in ways that assume direct installation to the
destination library.

Staged installation can currently be overridden by having a line
StagedInstall: no in the package's &lsquo;DESCRIPTION&rsquo; file,
via flag --no-staged-install or by setting environment
variable R_INSTALL_STAGED to a false value
(e.g. false or no).

Staged installation requires either --pkglock or
--lock, one of which is used by default.

The options do not have to precede pkgs on the command line,
although it will be more legible if they do. All the options are
processed before any packages, and where options have conflicting
effects the last one will win.

Some parts of the operation of <code>INSTALL</code> depend on the R
temporary directory (see <code><a href="../../base/html/tempfile.html">tempdir</a></code>, usually under
&lsquo;/tmp&rsquo;) having both write and execution access to the account
running R. This is usually the case, but if &lsquo;/tmp&rsquo; has been
mounted as <code>noexec</code>, environment variable TMPDIR may need
to be set to a directory from which execution is allowed.

<code><a href="REMOVE.html">REMOVE</a></code>;
<code><a href="../../base/html/libPaths.html">.libPaths</a></code> for information on using several library trees;
<code><a href="install.packages.html">install.packages</a></code> for R-level installation of packages;
<code><a href="update.packages.html">update.packages</a></code> for automatic update of packages using
the Internet or a local repository.

The section on &ldquo;Add-on packages&rdquo; in &ldquo;R Installation and
Administration&rdquo; and the chapter on &ldquo;Creating R packages&rdquo; in
&ldquo;Writing R Extensions&rdquo;
via <code><a href="RShowDoc.html">RShowDoc</a></code> or in the &lsquo;doc/manual&rsquo;
subdirectory of the R source tree.

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