download_file: Download a file from GitHub

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

Description

This function downloads a file in the specified commit to the path provided.

Usage

download_file(from_path, to_path, ref, repo, ...)

Arguments

from_path	(string) The path to the file to download, within the repository.
to_path	(string) The path to download the file to.
ref	(string) Either a SHA, branch or tag used to identify the commit.
repo	(string) The repository specified in the format: owner/repo.
...	Parameters passed to gh_request().

Details

Note: The GitHub API imposes a file size limit of 100MB for this request.

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/repos#get-repository-content

• https://docs.github.com/en/rest/reference/git#get-a-blob

Value

download_file() returns the path where the file is downloaded to.

Examples

## Not run: 

  # Download the README file from the main branch
  download_file(
    from_path = "README.md",
    to_path   = "~/README.md",
    ref       = "main",
    repo      = "ChadGoymer/githapi"
  )


## End(Not run)

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