R: Attempts to install a package directly from GitHub.

install_github {remotes} | R Documentation

## 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, ref = "master", subdir = NULL,
      auth_token = github_pat(), host = "api.github.com",
      dependencies = NA, upgrade = c("ask", "always", "never"),
      force = FALSE, quiet = FALSE, build = TRUE,
      build_opts = c("--no-resave-data", "--no-manual",
      "--no-build-vignettes"), repos = getOption("repos"),
      type = getOption("pkgType"), ...)

### 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.
`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, 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).
`upgrade` | One of "ask", "always" or "never". "ask" prompts the user for which out of date packages to upgrade. For non-interactive sessions "ask" is equivalent to "always". `TRUE` and `FALSE` are also accepted and correspond to "always" and "never" respectively.
`force` | Force installation, even if the remote state has not changed since the previous install.
`quiet` | If `TRUE`, suppress output.
`build` | If `TRUE` build the package before installing.
`build_opts` | Options to pass to `R CMD build`, only used when `build` is `TRUE`.
`repos` | A character vector giving repositories to use.
`type` | Type of package to `update`.
`...` | Other arguments passed on to `utils::install.packages()`.

### Details

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

### See Also

`github_pull()`

Other package installation: `install_bioc`, `install_bitbucket`, `install_cran`, `install_dev`, `install_gitlab`, `install_git`, `install_local`, `install_svn`, `install_url`, `install_version`

### 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"))

    # 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)

[Package remotes version 2.0.1 Index]