Skip to Content

install_github {devtools}

Attempts to install a package directly from github.
Package: 
devtools
Version: 
1.4.1

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

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 specified, the values in repo take precedence.
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
...
Other arguments passed on to install.

See Also

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

Examples

## Not run:
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")
 
## End(Not run)

Documentation reproduced from package devtools, version 1.4.1. License: GPL (>= 2)