INSTALL                package:utils                R Documentation

_I_n_s_t_a_l_l _A_d_d-_o_n _P_a_c_k_a_g_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     Utility for installing add-on packages.

_U_s_a_g_e:

     R CMD INSTALL [options] [-l lib] pkgs

_A_r_g_u_m_e_n_t_s:

    pkgs: a space-separated list with the path names of the packages to
          be installed.

     lib: the path name of the R library tree to install to.  Also
          accepted in the form '--library=lib'.

 options: a space-separated list of options through which in particular
          the process for building the help files can be controlled.
          Most options should only be given once, and paths including
          spaces should be quoted.  Use 'R CMD INSTALL --help' for the
          full current list of options.

_D_e_t_a_i_l_s:

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

     If used as 'R CMD INSTALL pkgs' without explicitly specifying
     'lib', 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 'lib', use 'R CMD INSTALL -l lib
     pkgs'.  This prepends 'lib' 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 'lib' and the elements of 'pkgs' may be absolute or relative
     path names of directories.  'pkgs' may also contain names of
     package/bundle archive files of the form 'pkg_version.tar.gz' as
     obtained from CRAN: these are then extracted to a temporary
     directory. Finally, binary package/bundle archive files (as
     created by 'R CMD build --binary' can be supplied.

     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 'configure' 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 'LIBS' and 'CPPFLAGS' to specify these
     locations (and set these via '--configure-vars'), see section
     "Configuration variables" in "R Installation and Administration"
     for more information.  (If these are used more than once on the
     command line they are concatenated.)  One can bypass the configure
     mechanism using the option '--no-configure'.

     If '--no-docs' is given, no help files are built.  Options
     '--no-text', '--no-html', and '--no-latex' suppress creating the
     text, HTML, and LaTeX versions, respectively.  The default is to
     build help files in all three versions.  Similarly, '--no-example'
     suppresses extraction of the R code for the examples from the help
     files.

     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.

     By default the library directory is 'locked' by creating a
     directory '00LOCK' 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/bundle to
     restore on error.  A finer-grained locking is provided by the
     option '--pkglock' which creates a separate lock for each
     package/bundle: this allows enough freedom for careful parallel
     installation as done by 'install.packages(Ncpus = n)' with 'n >
     1'.  Finally locking (and restoration on error) can be suppressed
     by '--no-lock' or '--unsafe' (two names for the same option).

     Some platforms (notably Mac OS X) support sub-architectures in
     which binaries for different CPUs are installed within the same
     library tree. For such installations, the default behaviour is to
     try to build packages for all installed sub-architectures unless
     the package has a configure script or a 'src/Makefile', when only
     the sub-architecture running 'R CMD INSTALL' is used.  To use only
     that sub-architecture, use '--no-multiarch'.  To install just the
     compiled code for another sub-architecture, use '--libs-only'.

     Use 'R CMD INSTALL --help' for concise usage information,
     including all the available options

_P_a_c_k_a_g_e_s _u_s_i_n_g _t_h_e _m_e_t_h_o_d_s _p_a_c_k_a_g_e:

     Packages that require the methods package and make use functions
     such as 'setMethod' or 'setClass', should be installed using
     lazy-loading (or, deprecated, by creating a binary image): use the
     field 'LazyLoad' in the 'DESCRIPTION' file to ensure this.

_N_o_t_e:

     Some parts of the operation of 'INSTALL' depend on the R temporary
     directory (see 'tempdir', usually under '/tmp') having both write
     and execution access to the account running R.  This is usually
     the case, but if '/tmp' has been mounted as 'noexec', environment
     variable 'TMPDIR' may need to be set to a directory from which
     execution is allowed.

_S_e_e _A_l_s_o:

     'REMOVE' and 'library' for information on using several library
     trees; 'update.packages' for automatic update of packages using
     the internet (or other R level installation of packages, such as
     by 'install.packages').

     The section on "Add-on packages" in "R Installation and
     Administration" and the chapter on "Creating R packages" in
     "Writing R Extensions" 'RShowDoc' and the 'doc/manual'
     subdirectory of the R source tree).

