gh_download: Download a file from GitHub

In ChadGoymer/githapi: User-friendly access to the GitHub API for R

Description

This function downloads a file from GitHub in as a binary object.

Usage

gh_download(
  url,
  path,
  headers = NULL,
  accept = NULL,
  token = getOption("github.token"),
  proxy = getOption("github.proxy"),
  ...
)

Arguments

url	(string) The address of the API endpoint.
path	(string) The path to download the file to.
headers	(character, optional) Headers to add to the request. Default: NULL.
accept	(string, optional) The mime format to accept when making the call. Default: NULL.
token	(string or Token, optional) An authorisation token to include with the request. If NULL the OAuth process is triggered. Default: NULL.
proxy	(character, optional) The proxy server to use to connect to the github API. If NULL then no proxy is used. Can be set in the option github.proxy or the environment variable GITHUB_PROXY. Default: NULL.
...	Ignored.

Value

A github string object containing the path, with the attributes:

• url: The URLs the request was sent to

• request: The type of HTTP request made

• status: The HTTP status code returned

• header: The HTTP header returned

Examples

## Not run: 

  # Find an issue by title
  gh_download(
    url  = "https://api.github.com/repos/ChadGoymer/githapi/zipball/main",
    path = "~/githapi-main.zip"
  )


## End(Not run)

ChadGoymer/githapi documentation built on Oct. 22, 2021, 10:56 a.m.