download.github: Download GitHub Repository

Description Usage Arguments Value Note See Also Examples

View source: R/download.github.R

Description

Download a repository from GitHub in ‘tar.gz’ format.

Usage

1
download.github(repo, dir = ".", quiet = FALSE)

Arguments

repo

GitHub reference of the form owner/repo[/subdir]@ref.

dir

directory to download to.

quiet

whether to suppress messages.

Value

Name of downloaded tar.gz file.

Note

In general, TAF scripts do not access the internet using download.github or similar functions. Instead, data and software are declared in DATA.bib and SOFTWARE.bib and then downloaded using taf.bootstrap. The exception is when a bootstrap script is used to fetch files from a web service (see TAF Wiki).

See Also

taf.bootstrap uses download.github to fetch software and data repositories.

download downloads a file.

untar extracts a tar.gz archive.

taf.install installs a package in tar.gz format.

TAF-package gives an overview of the package.

Examples

1
2
3
4
5
6
7
8
## Not run: 
# Specify release tag
download.github("ices-tools-prod/icesAdvice@1.3-0")

# Specify SHA reference code
download.github("ices-tools-prod/icesAdvice@4271797")

## End(Not run)

TAF documentation built on April 7, 2021, 5:06 p.m.