gh_download: Download the entire tree from a commit

Description Usage Arguments Value

View source: R/repositories-deprecated.R

Description

NOTE: This function has been deprecated, please use download_commit() instead.

Usage

1
2
3
4
5
6
7
8
gh_download(
  ref,
  repo,
  path,
  token = gh_token(),
  api = getOption("github.api"),
  ...
)

Arguments

ref

(string) A git reference: either a SHA-1, tag or branch. If a branch is specified the head commit is used.

repo

(string) The repository specified in the format: owner/repo.

path

(string) The path to save to.

token

(string, optional) The personal access token for GitHub authorisation. Default: value stored in the environment variable GITHUB_TOKEN or GITHUB_PAT.

api

(string, optional) The URL of GitHub's API. Default: the value stored in the environment variable GITHUB_API or https://api.github.com.

...

Parameters passed to gh_download_binary().

Value

Full tree of files in specified location.


ChadGoymer/githapi documentation built on March 28, 2020, 11:36 p.m.