Attempts to install a package directly from GitHub.

This function is vectorised onrepo so you can install multiplepackages in a single command.

Usage

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"),...)

Arguments

repo

Repository address in the formatusername/repo[/subdir][@ref|#pull|@*release]. Alternatively, you canspecifysubdir and/orref using the respective parameters(see below); if both are specified, the values inrepo takeprecedence.

ref

Desired git reference. Could be a commit, tag, or branchname, or a call togithub_pull() orgithub_release(). Defaults to"HEAD", which means the default branch on GitHub and for git remotes.Seesetting-the-default-branchfor more details.

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 totheGITHUB_PAT environment variable.

host

GitHub API host to use. Override with your GitHub enterprisehostname, for example,"github.hostname.com/api/v3".

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.

TRUE is shorthand for "Depends", "Imports", "LinkingTo" and"Suggests".NA is shorthand for "Depends", "Imports" and "LinkingTo"and is the default.FALSE is shorthand for no dependencies (i.e.just check this package, not its dependencies).

The value "soft" means the same asTRUE, "hard" means the same asNA.

You can also specify dependencies from one or more additional fields,common ones include:

• Config/Needs/website - for dependencies used in building the pkgdown site.

• Config/Needs/coverage for dependencies used in calculating test coverage.

upgrade

Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default"respects the value of theR_REMOTES_UPGRADE environment variable if set,and falls back to "ask" if unset. "ask" prompts the user for which out ofdate packages to upgrade. For non-interactive sessions "ask" is equivalentto "always".TRUE andFALSE are also accepted and correspond to"always" and "never" respectively.

force

Force installation, even if the remote state has not changedsince the previous install.

quiet

IfTRUE, suppress output.

build

IfTRUE build the package before installing.

build_opts

Options to pass toR CMD build, only used whenbuild isTRUE.

build_manual

IfFALSE, don't build PDF manual ('--no-manual').

build_vignettes

IfFALSE, don't build package vignettes ('--no-build-vignettes').

repos

A character vector giving repositories to use.

type

Type of package toupdate.

...

Other arguments passed on toutils::install.packages().

Details

If the repository uses submodules a command-line git client is required toclone the submodules.

See also

Examples