Usage

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 are 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/tokens 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.

Details

Attempting to install from a source repository that uses submodules
raises a warning. Because the zipped sources provided by GitHub do not
include submodules, this may lead to unexpected behaviour or compilation
failure in source packages. In this case, cloning the repository manually
using install_git with args="--recursive" may yield
better results.