devtools (version 1.5)

install_github: Attempts to install a package directly from github.

Description

This function is vectorised on repo so you can install multiple packages in a single command.

Usage

install_github(repo, username = getOption("github.user"), ref = "master",
  pull = NULL, subdir = NULL, branch = NULL, auth_user = NULL,
  password = NULL, auth_token = github_pat(), ..., dependencies = TRUE)

Arguments

repo

Repository address in the format [username/]repo[/subdir][@ref|#pull]. Alternatively, you can specify username, subdir, ref or pull using the respective parameters (see below); if both is sp

username

User name

ref

Desired git reference. Could be a commit, tag, or branch name. Defaults to "master".

pull

Desired pull request. A pull request refers to a branch, so you can't specify both branch and pull; one of them must be NULL.

subdir

subdirectory within repo that contains the R package.

branch

Deprecated. Use ref instead.

auth_user

your account username if you're attempting to install a package hosted in a private repository (and your username is different to username)

password

your password

auth_token

To install from a private repo, generate a personal access token (PAT) in https://github.com/settings/applications and supply to this argument. This is safer than using a password because you can easily delete a PAT without affecting any others

...

Other arguments passed on to install.

dependencies

By default, installs all dependencies so that you can build vignettes and use all functionality of the package.

See Also

Other package installation: install_bitbucket; install_gitorious; install_git; install_url; install_version; install

Examples

install_github("roxygen")
install_github("wch/ggplot2")
install_github(c("rstudio/httpuv", "rstudio/shiny"))
install_github(c("devtools@devtools-1.4", "klutometis/roxygen#142", "mfrasca/r-logging/pkg))

# Update devtools to the latest version, on Linux and Mac
# On Windows, this won't work - see ?build_github_devtools
install_github("hadley/devtools")

# To install from a private repo, use auth_token with a token
# from https://github.com/settings/applications. 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")