1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
%
% use.R
%
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\name{use}
\alias{use.default}
\alias{use}
\title{Attaches or loads packages}
\description{
Attaches or loads packages.
If a package is not installed, it (and its dependencies) will be
installed from one of the (known) repositories.
}
\usage{
\method{use}{default}(pkg="R.utils", version=NULL, how=c("attach", "load"), quietly=TRUE,
warn.conflicts=!quietly, install=getOption("R.utils.use.install",
Sys.getenv("R_R_UTILS_USE_INSTALL", "TRUE")), repos=getOption("use/repos",
c("[[current]]", "[[mainstream]]")), ..., verbose=FALSE)
}
\arguments{
\item{pkg}{A \code{\link[base]{character}} \code{\link[base]{vector}} specifying the package(s) to be used.}
\item{version}{(optional) Version constraint(s) on requested package(s).}
\item{how}{A \code{\link[base]{character}} string specifying whether the package should be attached or loaded.}
\item{quietly}{If \code{\link[base:logical]{TRUE}}, minimal or no messages are reported.}
\item{warn.conflicts}{If \code{\link[base:logical]{TRUE}}, warnings on namespace conflicts are reported, otherwise not.}
\item{install}{If \code{\link[base:logical]{TRUE}} and the package is not installed or an too old version is installed, then tries to install a newer version, otherwise not.}
\item{repos}{(optional) A \code{\link[base]{character}} \code{\link[base]{vector}} specifying from which repositories
to install the package from, iff a requested package is not already installed.}
\item{...}{Additional \emph{named} arguments passed to
\code{\link[base]{require}}() or \code{\link[base]{requireNamespace}}().}
\item{verbose}{If \code{\link[base:logical]{TRUE}}, verbose output is generated (regardless
of \code{quietly}).}
}
\value{
Returns a \code{\link[base]{vector}} of \code{\link[base]{package_version}}() for each package
attached/loaded.
If one of the requested packages/package versions is not available
and could not be installed, an error is thrown.
}
\seealso{
\code{\link[base]{library}}() and "base::install.packages".
To modify the set of known repositories, set option \code{repos}
(see \code{\link[base]{options}}()),
which can also be done via \code{\link[utils]{setRepositories}}.
}
\examples{\dontrun{
use("digest")
use("digest (>= 0.6.3)")
use("digest (>= 0.6.3)", repos=c("CRAN", "R-Forge"))
use("(CRAN|R-Forge)::digest (>= 0.6.3)")
use("BioCsoft::ShortRead")
use("digest, R.rsp (>= 0.9.17)")
}}
\keyword{programming}
\keyword{utilities}
\keyword{internal}
|
