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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/install-remote.R
\name{install_remote}
\alias{install_remote}
\alias{add_metadata}
\alias{remote_download}
\alias{remote_metadata}
\alias{remote_package_name}
\alias{remote_sha}
\title{Install a remote package.}
\usage{
install_remote(
remote,
dependencies,
upgrade,
force,
quiet,
build,
build_opts,
build_manual,
build_vignettes,
repos,
type,
...
)
add_metadata(pkg_path, meta)
remote_download(x, quiet = FALSE)
remote_metadata(x, bundle = NULL, source = NULL, sha = NULL)
remote_package_name(remote, ...)
remote_sha(remote, ...)
}
\arguments{
\item{dependencies}{Which dependencies do you want to check?
Can be a character vector (selecting from "Depends", "Imports",
"LinkingTo", "Suggests", or "Enhances"), or a logical vector.
\code{TRUE} is shorthand for "Depends", "Imports", "LinkingTo" and
"Suggests". \code{NA} is shorthand for "Depends", "Imports" and "LinkingTo"
and is the default. \code{FALSE} is shorthand for no dependencies (i.e.
just check this package, not its dependencies).
The value "soft" means the same as \code{TRUE}, "hard" means the same as \code{NA}.
You can also specify dependencies from one or more additional fields,
common ones include:
\itemize{
\item Config/Needs/website - for dependencies used in building the pkgdown site.
\item Config/Needs/coverage for dependencies used in calculating test coverage.
}}
\item{upgrade}{Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"
respects the value of the \code{R_REMOTES_UPGRADE} environment variable if set,
and falls back to "ask" if unset. "ask" prompts the user for which out of
date packages to upgrade. For non-interactive sessions "ask" is equivalent
to "always". \code{TRUE} and \code{FALSE} are also accepted and correspond to
"always" and "never" respectively.}
\item{force}{Force installation, even if the remote state has not changed
since the previous install.}
\item{quiet}{If \code{TRUE}, suppress output.}
\item{build}{If \code{TRUE} build the package before installing.}
\item{build_opts}{Options to pass to \verb{R CMD build}, only used when \code{build} is \code{TRUE}.}
\item{build_manual}{If \code{FALSE}, don't build PDF manual ('--no-manual').}
\item{build_vignettes}{If \code{FALSE}, don't build package vignettes ('--no-build-vignettes').}
\item{repos}{A character vector giving repositories to use.}
\item{type}{Type of package to \code{update}.}
\item{...}{Other arguments passed on to \code{\link[utils:install.packages]{utils::install.packages()}}.}
}
\description{
This:
\enumerate{
\item downloads source bundle
\item decompresses & checks that it's a package
\item adds metadata to DESCRIPTION
\item calls install
}
}
\details{
It uses the additional S3 generic functions to work. Writing methods for
these functions would allow 3rd party packages to define custom remotes.
}
\keyword{internal}
|
