github_release_info: Github release information

In richfitz/datastorr: Simple Data Versioning

Description

Information to describe how to process github releases

Usage

github_release_info(repo, read, private = FALSE, filename = NULL,
  path = NULL)

Arguments

repo	Name of the repo in username/repo format.
read	Function to read the file. See Details.
private	Is the repository private? If so authentication will be required for all actions. Setting this is optional but will result in better error messages because of the way GitHub returns not found/404 (rather than forbidden/403) errors when accessing private repositories without authorisation.
filename	Optional filename. If omitted, all files in the release can be used. If the filename contains a star ("*") it will be treated as a filename glob. So you can do filename = "*.csv" to match all csv files (dynamically computed on each release).
path	Optional path in which to store the data. If omitted we use datastorr_path to generate a reasonable path.

Details

The simplest case is where the data are stored in a single file attached to the release (this is different to the zip/tar.gz files that the web interface displays). For example, a single csv file. In that case the filename argument can be safely ommited and we'll work it out based on the filename.

richfitz/datastorr documentation built on July 9, 2021, 12:08 p.m.