Install a package from GitLab

This function is vectorised on repo so you can install multiple packages in a single command. Like other remotes the repository will skip installation if force == FALSE (the default) and the remote state has not changed since the previous installation.

install_gitlab(
  repo,
  subdir = NULL,
  auth_token = gitlab_pat(quiet),
  host = "gitlab.com",
  dependencies = NA,
  upgrade = c("default", "ask", "always", "never"),
  force = FALSE,
  quiet = FALSE,
  build = TRUE,
  build_opts = c("--no-resave-data", "--no-manual", "--no-build-vignettes"),
  build_manual = FALSE,
  build_vignettes = FALSE,
  repos = getOption("repos"),
  type = getOption("pkgType"),
  ...
)

Arguments

repo	Repository address in the format username/repo[@ref].
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://gitlab.com/profile/personal_access_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 GITLAB_PAT environment variable.
host	GitLab API host to use. Override with your GitLab enterprise hostname, for example, "gitlab.hostname.com".
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 "default", "ask", "always", or "never". "default" respects the value of the R_REMOTES_UPGRADE environment variable if set, and falls back to "ask" if unset. "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
build_manual	If FALSE, don't build PDF manual ('--no-manual').
build_vignettes	If FALSE, don't build package vignettes ('--no-build-vignettes'). is TRUE.
repos	A character vector giving repositories to use.
type	Type of package to update.
...	Other arguments passed on to utils::install.packages().

See also

Other package installation: install_bioc(), install_bitbucket(), install_cran(), install_dev(), install_github(), install_git(), install_local(), install_svn(), install_url(), install_version()

Examples

if (FALSE) {
install_gitlab("jimhester/covr")
}