Skip to contents

Source code: copied from "remotes" https://github.com/r-lib/remotes/blob/bd970d723facc6ede2ff0f54ce4ae917526a37f8/install-github.R (required for downloading private repos!)

Usage

download_github(
  repo,
  ref = NULL,
  dest_dir = tempdir(),
  use_zip = FALSE,
  quiet = FALSE,
  auth_token = Sys.getenv("GITHUB_PAT")
)

Arguments

repo

Github repo (e.g. "kwb-r/kwb.utils")

ref

default: "NULL" (i.e. defaults to "master" or "main" branch)

dest_dir

dest directory (default: tempdir())

use_zip

should files be downloades as .tar.gz (use_zip=FALSE) or as .zip files (use_zip=TRUE); default: FALSE

quiet

print messages (default: TRUE)

auth_token

auth_token (needed to download "private" repos), default: Sys.getenv("GITHUB_PAT")

Value

downloaded repo in dest. folder