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 = NULL, ref = "master", subdir = NULL,
  auth_token = github_pat(), host = "api.github.com", ...)

Arguments

repo

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

username

User name. Deprecated: please include username in the repo

ref

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

subdir

subdirectory within repo that contains the R package.

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. Defaults to the GITHUB_PAT environment variable.

host

Github API host to use. Override with your github enterprise hostname.

...

Other arguments passed on to install.

See also

github_pull

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

Examples

## Not run: 
install_github("klutometis/roxygen")
install_github("wch/ggplot2")
install_github(c("rstudio/httpuv", "rstudio/shiny"))
install_github(c("hadley/httr@v0.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")


## End(Not run)
Documentation reproduced from package devtools, version 1.6.1, License: GPL (>= 2)