| Title: | R Package Installation from Remote Repositories, Including'GitHub' |
|---|---|
| Description: | Download and install R packages stored in 'GitHub', 'GitLab', 'Bitbucket', 'Bioconductor', or plain 'subversion' or 'git' repositories. This package provides the 'install_*' functions in 'devtools'. Indeed most of the code was copied over from 'devtools'. |
| Authors: | Gábor Csárdi [aut, cre], Jim Hester [aut], Hadley Wickham [aut], Winston Chang [aut], Martin Morgan [aut], Dan Tenenbaum [aut], Posit Software, PBC [cph, fnd], Ascent Digital Services [cph] |
| Maintainer: | Gábor Csárdi <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 2.5.0.9000 |
| Built: | 2025-11-20 07:03:10 UTC |
| Source: | https://github.com/r-lib/remotes |
It downloads the package to a temporary file, andreturns the name of the file.
download_version( package, version = NULL, repos = getOption("repos"), type = getOption("pkgType"), ...)download_version( package, version=NULL, repos= getOption("repos"), type= getOption("pkgType"),...)
package | Name of the package to install. |
version | Version of the package to install. Can either be a string giving the exactversion required, or a specification in the same format as the parenthesized expressions usedin package dependencies. One of the following formats:
|
repos | character vector, the base URL(s) of the repositoriesto use, e.g., the URL of a CRAN mirror such as Can be |
type | character, indicating the type of package to download andinstall. Will be |
... | Other arguments passed on to |
Name of the downloaded file.
Use asref parameter toinstall_github().Allows installing a specific pull request or the latest release.
github_pull(pull)github_release()github_pull(pull)github_release()
pull | Character string specifying the pull request to install |
github_pull("42")github_pull("42")
This function requiresgit to be installed on your system in order tobe used.
install_bioc( repo, mirror = getOption("BioC_git", download_url("git.bioconductor.org/packages")), git = c("auto", "git2r", "external"), dependencies = NA, upgrade = c("default", "ask", "always", "never"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption("repos"), type = getOption("pkgType"), ...)install_bioc( repo, mirror= getOption("BioC_git", download_url("git.bioconductor.org/packages")), git= c("auto","git2r","external"), dependencies=NA, upgrade= c("default","ask","always","never"), force=FALSE, quiet=FALSE, build=TRUE, build_opts= c("--no-resave-data","--no-manual","--no-build-vignettes"), build_manual=FALSE, build_vignettes=FALSE, repos= getOption("repos"), type= getOption("pkgType"),...)
repo | Repository address in the format |
mirror | The Bioconductor git mirror to use |
git | Whether to use the |
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.
The value "soft" means the same as You can also specify dependencies from one or more additional fields,common ones include:
|
upgrade | Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"respects the value of the |
force | Force installation, even if the remote state has not changedsince the previous install. |
quiet | If |
build | If |
build_opts | Options to pass to |
build_manual | If |
build_vignettes | If |
repos | A character vector giving repositories to use. |
type | Type of package to |
... | Other arguments passed on to |
It is vectorised so you can install multiple packages witha single command.
This is intended as an aid for Bioconductor developers. If you want toinstall the release version of a Bioconductor package one can use theBiocManager package.
Other package installation:install_bitbucket(),install_cran(),install_dev(),install_github(),install_gitlab(),install_git(),install_local(),install_svn(),install_url(),install_version()
## Not run: install_bioc("SummarizedExperiment")install_bioc("devel/SummarizedExperiment")install_bioc("3.3/SummarizedExperiment")install_bioc("SummarizedExperiment#abc123")install_bioc("user:password@release/SummarizedExperiment")install_bioc("user:password@devel/SummarizedExperiment")install_bioc("user:password@SummarizedExperiment#abc123")## End(Not run)## Not run:install_bioc("SummarizedExperiment")install_bioc("devel/SummarizedExperiment")install_bioc("3.3/SummarizedExperiment")install_bioc("SummarizedExperiment#abc123")install_bioc("user:password@release/SummarizedExperiment")install_bioc("user:password@devel/SummarizedExperiment")install_bioc("user:password@SummarizedExperiment#abc123")## End(Not run)
This function is vectorised so you can install multiple packages ina single command.
install_bitbucket( repo, ref = "HEAD", subdir = NULL, auth_user = bitbucket_user(), password = bitbucket_password(), host = "api.bitbucket.org/2.0", dependencies = NA, upgrade = c("default", "ask", "always", "never"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption("repos"), type = getOption("pkgType"), ...)install_bitbucket( repo, ref="HEAD", subdir=NULL, auth_user= bitbucket_user(), password= bitbucket_password(), host="api.bitbucket.org/2.0", dependencies=NA, upgrade= c("default","ask","always","never"), force=FALSE, quiet=FALSE, build=TRUE, build_opts= c("--no-resave-data","--no-manual","--no-build-vignettes"), build_manual=FALSE, build_vignettes=FALSE, repos= getOption("repos"), type= getOption("pkgType"),...)
repo | Repository address in the format |
ref | Desired git reference; could be a commit, tag, or branch name.Defaults to HEAD. |
subdir | Subdirectory within repo that contains the R package. |
auth_user | your account username if you're attempting to installa package hosted in a private repository (and your username is differentto |
password | your password. Defaults to the |
host | GitHub API host to use. Override with your GitHub enterprisehostname, for example, |
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.
The value "soft" means the same as You can also specify dependencies from one or more additional fields,common ones include:
|
upgrade | Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"respects the value of the |
force | Force installation, even if the remote state has not changedsince the previous install. |
quiet | If |
build | If |
build_opts | Options to pass to |
build_manual | If |
build_vignettes | If |
repos | A character vector giving repositories to use. |
type | Type of package to |
... | Other arguments passed on to |
To install from a private repo, or more generally, access theBitbucket API with your own credentials, you will need to get an accesstoken. You can create an access token following the instructions found intheBitbucketApp Passwords documentation. The App Password requires read-only access toyour repositories and pull requests. Then store your password in theenvironment variableBITBUCKET_PASSWORD (e.g.evelynwaugh:swordofhonour)
Note that on Windows, authentication requires the "libcurl" downloadmethod. You can set the default download method via thedownload.file.method option:
options(download.file.method = "libcurl")
In particular, if unset, RStudio sets the download method to "wininet".To override this, you might want to set it to "libcurl" in yourR profile, seebase::Startup. The caveat of the "libcurl" method isthat it doesnot set the system proxies automatically, see"Setting Proxies" inutils::download.file().
Bitbucket API docs:https://confluence.atlassian.com/bitbucket/use-the-bitbucket-cloud-rest-apis-222724129.html
Other package installation:install_bioc(),install_cran(),install_dev(),install_github(),install_gitlab(),install_git(),install_local(),install_svn(),install_url(),install_version()
## Not run: install_bitbucket("sulab/mygene.r@default")install_bitbucket("djnavarro/lsr")## End(Not run)## Not run:install_bitbucket("sulab/mygene.r@default")install_bitbucket("djnavarro/lsr")## End(Not run)
This function is vectorised onpkgs so you can install multiplepackages in a single command.
install_cran( pkgs, repos = getOption("repos"), type = getOption("pkgType"), dependencies = NA, upgrade = c("default", "ask", "always", "never"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"), build_manual = FALSE, build_vignettes = FALSE, ...)install_cran( pkgs, repos= getOption("repos"), type= getOption("pkgType"), dependencies=NA, upgrade= c("default","ask","always","never"), force=FALSE, quiet=FALSE, build=TRUE, build_opts= c("--no-resave-data","--no-manual","--no-build-vignettes"), build_manual=FALSE, build_vignettes=FALSE,...)
pkgs | A character vector of packages to install. |
repos | A character vector giving repositories to use. |
type | Type of package to |
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.
The value "soft" means the same as You can also specify dependencies from one or more additional fields,common ones include:
|
upgrade | Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"respects the value of the |
force | Force installation, even if the remote state has not changedsince the previous install. |
quiet | If |
build | If |
build_opts | Options to pass to |
build_manual | If |
build_vignettes | If |
... | Other arguments passed on to |
Other package installation:install_bioc(),install_bitbucket(),install_dev(),install_github(),install_gitlab(),install_git(),install_local(),install_svn(),install_url(),install_version()
## Not run: install_cran("ggplot2")install_cran(c("httpuv", "shiny"))## End(Not run)## Not run:install_cran("ggplot2")install_cran(c("httpuv","shiny"))## End(Not run)
Install package dependencies if needed.
install_deps( pkgdir = ".", dependencies = NA, repos = getOption("repos"), type = getOption("pkgType"), upgrade = c("default", "ask", "always", "never"), quiet = FALSE, build = TRUE, build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"), build_manual = FALSE, build_vignettes = FALSE, ...)install_deps( pkgdir=".", dependencies=NA, repos= getOption("repos"), type= getOption("pkgType"), upgrade= c("default","ask","always","never"), quiet=FALSE, build=TRUE, build_opts= c("--no-resave-data","--no-manual","--no-build-vignettes"), build_manual=FALSE, build_vignettes=FALSE,...)
pkgdir | Path to a package directory, or to a package tarball. |
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.
The value "soft" means the same as You can also specify dependencies from one or more additional fields,common ones include:
|
repos | A character vector giving repositories to use. |
type | Type of package to |
upgrade | Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"respects the value of the |
quiet | If |
build | If |
build_opts | Options to pass to |
build_manual | If |
build_vignettes | If |
... | additional arguments passed to |
## Not run: install_deps(".")## Not run: install_deps(".")
install_dev() retrieves the package DESCRIPTION from the CRAN mirror andlooks in the 'URL' and 'BugReports' fields for GitHub, GitLab or BitbucketURLs. It then calls the appropriateinstall_() function to install thedevelopment package.
install_dev(package, cran_url = getOption("repos")[["CRAN"]], ...)install_dev(package, cran_url= getOption("repos")[["CRAN"]],...)
package | The package name to install. |
cran_url | The URL of the CRAN mirror to use, by default based on the'repos' option. If unset uses 'https://cloud.r-project.org'. |
... | Additional arguments passed to |
Other package installation:install_bioc(),install_bitbucket(),install_cran(),install_github(),install_gitlab(),install_git(),install_local(),install_svn(),install_url(),install_version()
## Not run: # From GitHubinstall_dev("dplyr")# From GitLabinstall_dev("iemiscdata")# From Bitbucketinstall_dev("argparser")## End(Not run)## Not run:# From GitHubinstall_dev("dplyr")# From GitLabinstall_dev("iemiscdata")# From Bitbucketinstall_dev("argparser")## End(Not run)
It is vectorised so you can install multiple packages witha single command. You do not need to have thegit2r package,or an external git client installed.
install_git( url, subdir = NULL, ref = NULL, branch = NULL, credentials = git_credentials(), git = c("auto", "git2r", "external"), dependencies = NA, upgrade = c("default", "ask", "always", "never"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption("repos"), type = getOption("pkgType"), ...)install_git( url, subdir=NULL, ref=NULL, branch=NULL, credentials= git_credentials(), git= c("auto","git2r","external"), dependencies=NA, upgrade= c("default","ask","always","never"), force=FALSE, quiet=FALSE, build=TRUE, build_opts= c("--no-resave-data","--no-manual","--no-build-vignettes"), build_manual=FALSE, build_vignettes=FALSE, repos= getOption("repos"), type= getOption("pkgType"),...)
url | Location of package. The url should point to a public orprivate repository. |
subdir | A sub-directory within a git repository that maycontain the package we are interested in installing. |
ref | Name of branch, tag or SHA reference to use, if not HEAD. |
branch | Deprecated, synonym for ref. |
credentials | A git2r credentials object passed through to clone.Supplying this argument implies using |
git | Whether to use the |
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.
The value "soft" means the same as You can also specify dependencies from one or more additional fields,common ones include:
|
upgrade | Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"respects the value of the |
force | Force installation, even if the remote state has not changedsince the previous install. |
quiet | If |
build | If |
build_opts | Options to pass to |
build_manual | If |
build_vignettes | If |
repos | A character vector giving repositories to use. |
type | Type of package to |
... | Other arguments passed on to |
If you need to set git credentials for use in theRemotes field you can doso by placing the credentials in theremotes.git_credentials globaloption.
Other package installation:install_bioc(),install_bitbucket(),install_cran(),install_dev(),install_github(),install_gitlab(),install_local(),install_svn(),install_url(),install_version()
## Not run: install_git("https://github.com/hadley/stringr.git")install_git("https://github.com/hadley/stringr.git", ref = "stringr-0.2")## End(Not run)## Not run:install_git("https://github.com/hadley/stringr.git")install_git("https://github.com/hadley/stringr.git", ref="stringr-0.2")## End(Not run)
This function is vectorised onrepo so you can install multiplepackages in a single command.
install_github( repo, ref = "HEAD", subdir = NULL, auth_token = github_pat(quiet), host = "api.github.com", dependencies = NA, upgrade = c("default", "ask", "always", "never"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption("repos"), type = getOption("pkgType"), ...)install_github( repo, ref="HEAD", subdir=NULL, auth_token= github_pat(quiet), host="api.github.com", dependencies=NA, upgrade= c("default","ask","always","never"), force=FALSE, quiet=FALSE, build=TRUE, build_opts= c("--no-resave-data","--no-manual","--no-build-vignettes"), build_manual=FALSE, build_vignettes=FALSE, repos= getOption("repos"), type= getOption("pkgType"),...)
repo | Repository address in the format |
ref | Desired git reference. Could be a commit, tag, or branchname, or a call to |
subdir | Subdirectory within repo that contains the R package. |
auth_token | To install from a private repo, generate a personalaccess token (PAT) with at least repo scope inhttps://github.com/settings/tokens andsupply to this argument. This is safer than using a password becauseyou can easily delete a PAT without affecting any others. Defaults tothe |
host | GitHub API host to use. Override with your GitHub enterprisehostname, for example, |
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.
The value "soft" means the same as You can also specify dependencies from one or more additional fields,common ones include:
|
upgrade | Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"respects the value of the |
force | Force installation, even if the remote state has not changedsince the previous install. |
quiet | If |
build | If |
build_opts | Options to pass to |
build_manual | If |
build_vignettes | If |
repos | A character vector giving repositories to use. |
type | Type of package to |
... | Other arguments passed on to |
If the repository uses submodules a command-line git client is required toclone the submodules.
Other package installation:install_bioc(),install_bitbucket(),install_cran(),install_dev(),install_gitlab(),install_git(),install_local(),install_svn(),install_url(),install_version()
## Not run: install_github("klutometis/roxygen")install_github("wch/ggplot2", ref = github_pull("142"))install_github(c("rstudio/httpuv", "rstudio/shiny"))install_github(c("hadley/[email protected]", "klutometis/roxygen#142", "r-lib/roxygen2@*release", "mfrasca/r-logging/pkg"))# To install from a private repo, use auth_token with a token# from https://github.com/settings/tokens. You only need the# repo scope. Best practice is to save your PAT in env var called# GITHUB_PAT.install_github("hadley/private", auth_token = "abc")# To pass option arguments to `R CMD INSTALL` use `INSTALL_opts`. e.g. toinstall a package with source references and testsinstall_github("rstudio/shiny", INSTALL_opts = c("--with-keep.source", "--install-tests"))## End(Not run)## Not run:install_github("klutometis/roxygen")install_github("wch/ggplot2", ref= github_pull("142"))install_github(c("rstudio/httpuv","rstudio/shiny"))install_github(c("hadley/[email protected]","klutometis/roxygen#142","r-lib/roxygen2@*release","mfrasca/r-logging/pkg"))# To install from a private repo, use auth_token with a token# from https://github.com/settings/tokens. You only need the# repo scope. Best practice is to save your PAT in env var called# GITHUB_PAT.install_github("hadley/private", auth_token="abc")# To pass option arguments to `R CMD INSTALL` use `INSTALL_opts`. e.g. toinstall a package with source references and testsinstall_github("rstudio/shiny", INSTALL_opts= c("--with-keep.source","--install-tests"))## End(Not run)
This function is vectorised onrepo so you can install multiplepackages in a single command. Like other remotes the repository will skipinstallation ifforce == FALSE (the default) and the remote state hasnot changed since the previous installation.
install_gitlab( repo, subdir = NULL, auth_token = gitlab_pat(quiet), host = "gitlab.com", dependencies = NA, upgrade = c("default", "ask", "always", "never"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption("repos"), type = getOption("pkgType"), ...)install_gitlab( repo, subdir=NULL, auth_token= gitlab_pat(quiet), host="gitlab.com", dependencies=NA, upgrade= c("default","ask","always","never"), force=FALSE, quiet=FALSE, build=TRUE, build_opts= c("--no-resave-data","--no-manual","--no-build-vignettes"), build_manual=FALSE, build_vignettes=FALSE, repos= getOption("repos"), type= getOption("pkgType"),...)
repo | Repository address in the format |
subdir | Subdirectory within repo that contains the R package. |
auth_token | To install from a private repo, generate a personal accesstoken (PAT) with at least read_api scope inhttps://docs.gitlab.com/ee/user/profile/personal_access_tokens.html andsupply to this argument. This is safer than using a password because youcan easily delete a PAT without affecting any others. Defaults to theGITLAB_PAT environment variable. |
host | GitLab API host to use. Override with your GitLab enterprisehostname, for example, |
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.
The value "soft" means the same as You can also specify dependencies from one or more additional fields,common ones include:
|
upgrade | Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"respects the value of the |
force | Force installation, even if the remote state has not changedsince the previous install. |
quiet | If |
build | If |
build_opts | Options to pass to |
build_manual | If |
build_vignettes | If |
repos | A character vector giving repositories to use. |
type | Type of package to |
... | Other arguments passed on to |
Other package installation:install_bioc(),install_bitbucket(),install_cran(),install_dev(),install_github(),install_git(),install_local(),install_svn(),install_url(),install_version()
## Not run: install_gitlab("jimhester/covr")## End(Not run)## Not run:install_gitlab("jimhester/covr")## End(Not run)
This function is vectorised so you can install multiple packages ina single command.
install_local( path = ".", subdir = NULL, dependencies = NA, upgrade = c("default", "ask", "always", "never"), force = FALSE, quiet = FALSE, build = !is_binary_pkg(path), build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption("repos"), type = getOption("pkgType"), ...)install_local( path=".", subdir=NULL, dependencies=NA, upgrade= c("default","ask","always","never"), force=FALSE, quiet=FALSE, build=!is_binary_pkg(path), build_opts= c("--no-resave-data","--no-manual","--no-build-vignettes"), build_manual=FALSE, build_vignettes=FALSE, repos= getOption("repos"), type= getOption("pkgType"),...)
path | path to local directory, or compressed file (tar, zip, tar.gztar.bz2, tgz2 or tbz) |
subdir | subdirectory within url bundle that contains the R package. |
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.
The value "soft" means the same as You can also specify dependencies from one or more additional fields,common ones include:
|
upgrade | Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"respects the value of the |
force | Force installation, even if the remote state has not changedsince the previous install. |
quiet | If |
build | If |
build_opts | Options to pass to |
build_manual | If |
build_vignettes | If |
repos | A character vector giving repositories to use. |
type | Type of package to |
... | Other arguments passed on to |
Other package installation:install_bioc(),install_bitbucket(),install_cran(),install_dev(),install_github(),install_gitlab(),install_git(),install_svn(),install_url(),install_version()
## Not run: dir <- tempfile()dir.create(dir)pkg <- download.packages("testthat", dir, type = "source")install_local(pkg[, 2])## End(Not run)## Not run:dir<- tempfile()dir.create(dir)pkg<- download.packages("testthat", dir, type="source")install_local(pkg[,2])## End(Not run)
This function requiressvn to be installed on your system in order tobe used.
install_svn( url, subdir = NULL, args = character(0), revision = NULL, dependencies = NA, upgrade = c("default", "ask", "always", "never"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption("repos"), type = getOption("pkgType"), ...)install_svn( url, subdir=NULL, args= character(0), revision=NULL, dependencies=NA, upgrade= c("default","ask","always","never"), force=FALSE, quiet=FALSE, build=TRUE, build_opts= c("--no-resave-data","--no-manual","--no-build-vignettes"), build_manual=FALSE, build_vignettes=FALSE, repos= getOption("repos"), type= getOption("pkgType"),...)
url | Location of package. The url should point to a public orprivate repository. |
subdir | A sub-directory within a svn repository that contains thepackage we are interested in installing. |
args | A character vector providing extra options to pass on to |
revision | svn revision, if omitted updates to latest |
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.
The value "soft" means the same as You can also specify dependencies from one or more additional fields,common ones include:
|
upgrade | Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"respects the value of the |
force | Force installation, even if the remote state has not changedsince the previous install. |
quiet | If |
build | If |
build_opts | Options to pass to |
build_manual | If |
build_vignettes | If |
repos | A character vector giving repositories to use. |
type | Type of package to |
... | Other arguments passed on to |
It is vectorised so you can install multiple packages witha single command.
Other package installation:install_bioc(),install_bitbucket(),install_cran(),install_dev(),install_github(),install_gitlab(),install_git(),install_local(),install_url(),install_version()
## Not run: install_svn("https://github.com/hadley/stringr/trunk")install_svn("https://github.com/hadley/httr/branches/oauth")## End(Not run)## Not run:install_svn("https://github.com/hadley/stringr/trunk")install_svn("https://github.com/hadley/httr/branches/oauth")## End(Not run)
This function is vectorised so you can install multiple packages ina single command.
install_url( url, subdir = NULL, dependencies = NA, upgrade = c("default", "ask", "always", "never"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption("repos"), type = getOption("pkgType"), ...)install_url( url, subdir=NULL, dependencies=NA, upgrade= c("default","ask","always","never"), force=FALSE, quiet=FALSE, build=TRUE, build_opts= c("--no-resave-data","--no-manual","--no-build-vignettes"), build_manual=FALSE, build_vignettes=FALSE, repos= getOption("repos"), type= getOption("pkgType"),...)
url | location of package on internet. The url should point to azip file, a tar file or a bzipped/gzipped tar file. |
subdir | subdirectory within url bundle that contains the R package. |
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.
The value "soft" means the same as You can also specify dependencies from one or more additional fields,common ones include:
|
upgrade | Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"respects the value of the |
force | Force installation, even if the remote state has not changedsince the previous install. |
quiet | If |
build | If |
build_opts | Options to pass to |
build_manual | If |
build_vignettes | If |
repos | A character vector giving repositories to use. |
type | Type of package to |
... | Other arguments passed on to |
Other package installation:install_bioc(),install_bitbucket(),install_cran(),install_dev(),install_github(),install_gitlab(),install_git(),install_local(),install_svn(),install_version()
## Not run: install_url("https://github.com/hadley/stringr/archive/HEAD.zip")## End(Not run)## Not run:install_url("https://github.com/hadley/stringr/archive/HEAD.zip")## End(Not run)
This function knows how to look in multiple CRAN-like package repositories, and in theirarchive directories, in order to find specific versions of the requested package.
install_version( package, version = NULL, dependencies = NA, upgrade = c("default", "ask", "always", "never"), force = FALSE, quiet = FALSE, build = FALSE, build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption("repos"), type = "source", ...)install_version( package, version=NULL, dependencies=NA, upgrade= c("default","ask","always","never"), force=FALSE, quiet=FALSE, build=FALSE, build_opts= c("--no-resave-data","--no-manual","--no-build-vignettes"), build_manual=FALSE, build_vignettes=FALSE, repos= getOption("repos"), type="source",...)
package | Name of the package to install. |
version | Version of the package to install. Can either be a string giving the exactversion required, or a specification in the same format as the parenthesized expressions usedin package dependencies. One of the following formats:
|
dependencies | logical indicating whether to also installuninstalled packages which these packages depend on/linkto/import/suggest (and so on recursively).Not used if Only supported if The default,
In all of these, |
upgrade | Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"respects the value of the |
force | Force installation, even if the remote state has not changedsince the previous install. |
quiet | logical: if true, reduce the amount of output. This isnotpassed to |
build | If |
build_opts | Options to pass to |
build_manual | If |
build_vignettes | If |
repos | character vector, the base URL(s) of the repositoriesto use, e.g., the URL of a CRAN mirror such as Can be |
type | character, indicating the type of package to download andinstall. Will be |
... | Other arguments passed on to |
The repositories are searched in the order specified by therepos argument. This enablesteams to maintain multiple in-house repositories with different policies - for instance, one repofor development snapshots and one for official releases. A common setup would be to first searchthe official release repo, then the dev snapshot repo, then a public CRAN mirror.
Older versions of packages on CRAN are usually only available in source form. If your requestedpackage contains compiled code, you will need to have an R development environment installed. Youcan check if you do by runningdevtools::has_devel (you need thedevtools package for this).
Other package installation:install_bioc(),install_bitbucket(),install_cran(),install_dev(),install_github(),install_gitlab(),install_git(),install_local(),install_svn(),install_url()
## Not run: install_version("devtools", "1.11.0")install_version("devtools", ">= 1.12.0, < 1.14")## Specify search order (e.g. in ~/.Rprofile)options(repos = c( prod = "http://mycompany.example.com/r-repo", dev = "http://mycompany.example.com/r-repo-dev", CRAN = "https://cran.revolutionanalytics.com"))install_version("mypackage", "1.15") # finds in 'prod'install_version("mypackage", "1.16-39487") # finds in 'dev'## End(Not run)## Not run:install_version("devtools","1.11.0")install_version("devtools",">= 1.12.0, < 1.14")## Specify search order (e.g. in ~/.Rprofile)options(repos= c( prod="http://mycompany.example.com/r-repo", dev="http://mycompany.example.com/r-repo-dev", CRAN="https://cran.revolutionanalytics.com"))install_version("mypackage","1.15")# finds in 'prod'install_version("mypackage","1.16-39487")# finds in 'dev'## End(Not run)
Find all the dependencies of a package and determine whether they are aheador behind CRAN. Aprint() method identifies mismatches (if any)between local and CRAN versions of each dependent package; anupdate() method installs outdated or missing packages from CRAN.
package_deps( packages, dependencies = NA, repos = getOption("repos"), type = getOption("pkgType"))local_package_deps(pkgdir = ".", dependencies = NA)dev_package_deps( pkgdir = ".", dependencies = NA, repos = getOption("repos"), type = getOption("pkgType"), remote_precedence = TRUE, additional_repositories = TRUE)## S3 method for class 'package_deps'update( object, dependencies = NA, upgrade = c("default", "ask", "always", "never"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption("repos"), type = getOption("pkgType"), ...)package_deps( packages, dependencies=NA, repos= getOption("repos"), type= getOption("pkgType"))local_package_deps(pkgdir=".", dependencies=NA)dev_package_deps( pkgdir=".", dependencies=NA, repos= getOption("repos"), type= getOption("pkgType"), remote_precedence=TRUE, additional_repositories=TRUE)## S3 method for class 'package_deps'update( object, dependencies=NA, upgrade= c("default","ask","always","never"), force=FALSE, quiet=FALSE, build=TRUE, build_opts= c("--no-resave-data","--no-manual","--no-build-vignettes"), build_manual=FALSE, build_vignettes=FALSE, repos= getOption("repos"), type= getOption("pkgType"),...)
packages | A character vector of package names. |
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.
The value "soft" means the same as You can also specify dependencies from one or more additional fields,common ones include:
|
repos | A character vector giving repositories to use. |
type | Type of package to |
pkgdir | Path to a package directory, or to a package tarball. |
remote_precedence | A logical flag specifying whether remote sources should take precedence overCRAN when both were found. |
additional_repositories | A logical flag specifying whether |
object | A |
upgrade | Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"respects the value of the |
force | Force installation, even if the remote state has not changedsince the previous install. |
quiet | If |
build | If |
build_opts | Options to pass to |
build_manual | If |
build_vignettes | If |
... | Additional arguments passed to |
Adata.frame with columns:
package | The dependent package's name, |
installed | The currently installed version, |
available | The version available on CRAN, |
diff | An integer denoting whether the locally installed versionof the package is newer (1), the same (0) or older (-1) than the versioncurrently available on CRAN. |
## Not run: package_deps("devtools")# Use update to update any out-of-date dependenciesupdate(package_deps("devtools"))## End(Not run)## Not run:package_deps("devtools")# Use update to update any out-of-date dependenciesupdate(package_deps("devtools"))## End(Not run)
A remote repo can be specified in two ways:
parse_github_url() handles HTTPS and SSH remote URLsand various GitHub browser URLs
parse_repo_spec() handles this concise form:[username/]repo[/subdir][#pull|@ref|@*release]
parse_repo_spec(repo)parse_github_repo_spec(repo)parse_github_url(repo)parse_repo_spec(repo)parse_github_repo_spec(repo)parse_github_url(repo)
repo | Character scalar, the repo specification. |
List with members:username,repo,subdirref,pull,release, some which will be empty.
parse_repo_spec("metacran/crandb")parse_repo_spec("jimhester/covr#47") ## pull requestparse_repo_spec("jeroen/[email protected]") ## specific tagparse_repo_spec("tidyverse/dplyr@*release") ## shorthand for latest releaseparse_repo_spec("r-lib/remotes@550a3c7d3f9e1493a2ba") ## commit SHAparse_repo_spec("igraph=igraph/rigraph") ## Different package name from repo nameparse_github_url("https://github.com/jeroen/curl.git")parse_github_url("[email protected]:metacran/crandb.git")parse_github_url("https://github.com/jimhester/covr")parse_github_url("https://github.example.com/user/repo.git")parse_github_url("[email protected]:user/repo.git")parse_github_url("https://github.com/r-lib/remotes/pull/108")parse_github_url("https://github.com/r-lib/remotes/tree/name-of-branch")parse_github_url("https://github.com/r-lib/remotes/commit/1234567")parse_github_url("https://github.com/r-lib/remotes/releases/latest")parse_github_url("https://github.com/r-lib/remotes/releases/tag/1.0.0")parse_repo_spec("metacran/crandb")parse_repo_spec("jimhester/covr#47")## pull requestparse_repo_spec("jeroen/[email protected]")## specific tagparse_repo_spec("tidyverse/dplyr@*release")## shorthand for latest releaseparse_repo_spec("r-lib/remotes@550a3c7d3f9e1493a2ba")## commit SHAparse_repo_spec("igraph=igraph/rigraph")## Different package name from repo nameparse_github_url("https://github.com/jeroen/curl.git")parse_github_url("[email protected]:metacran/crandb.git")parse_github_url("https://github.com/jimhester/covr")parse_github_url("https://github.example.com/user/repo.git")parse_github_url("[email protected]:user/repo.git")parse_github_url("https://github.com/r-lib/remotes/pull/108")parse_github_url("https://github.com/r-lib/remotes/tree/name-of-branch")parse_github_url("https://github.com/r-lib/remotes/commit/1234567")parse_github_url("https://github.com/r-lib/remotes/releases/latest")parse_github_url("https://github.com/r-lib/remotes/releases/tag/1.0.0")
Returns a character vector of commands to run that will install systemrequirements for the queried operating system.
system_requirements( os, os_release = NULL, path = ".", package = NULL, curl = Sys.which("curl"))system_requirements( os, os_release=NULL, path=".", package=NULL, curl= Sys.which("curl"))
os,os_release | The operating system and operating system release version, seehttps://github.com/rstudio/r-system-requirements#operating-systems for thelist of supported operating systems. If |
path | The path to the dev package's root directory. |
package | CRAN package name(s) to lookup system requirements for. If not |
curl | The location of the curl binary on your system. |
A character vector of commands needed to install the system requirements for the package.
Works similarly toutils::install.packages() but doesn't install packagesthat are already installed, and also upgrades out dated dependencies.
update_packages( packages = TRUE, dependencies = NA, upgrade = c("default", "ask", "always", "never"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption("repos"), type = getOption("pkgType"), ...)update_packages( packages=TRUE, dependencies=NA, upgrade= c("default","ask","always","never"), force=FALSE, quiet=FALSE, build=TRUE, build_opts= c("--no-resave-data","--no-manual","--no-build-vignettes"), build_manual=FALSE, build_vignettes=FALSE, repos= getOption("repos"), type= getOption("pkgType"),...)
packages | Character vector of packages to update. |
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.
The value "soft" means the same as You can also specify dependencies from one or more additional fields,common ones include:
|
upgrade | Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"respects the value of the |
force | Deprecated, this argument has no effect. |
quiet | If |
build | If |
build_opts | Options to pass to |
build_manual | If |
build_vignettes | If |
repos | A character vector giving repositories to use. |
type | Type of package to |
... | Other arguments passed on to |
package_deps() to see which packages are out of date/missing.
## Not run: update_packages("ggplot2")update_packages(c("plyr", "ggplot2"))## End(Not run)## Not run:update_packages("ggplot2")update_packages(c("plyr","ggplot2"))## End(Not run)