downloadModule: Download a module from a SpaDES module GitHub repository

Description

Download a .zip file of the module and extract (unzip) it to a user-specified location.

Usage

downloadModule(name, path, version, repo, data = FALSE, quiet = FALSE)

  ## S3 method for class 'character,character,character,character,logical,logical':
downloadModule(name,
  path, version, repo, data = FALSE, quiet = FALSE)
## S3 method for class 'character,character,character,missing,ANY,ANY':
downloadModule(name,
  path, version, data, quiet)
## S3 method for class 'character,character,missing,missing,ANY,ANY':
downloadModule(name,
  path, data, quiet)
## S3 method for class 'character,character,missing,character,ANY,ANY':
downloadModule(name,
  path, repo, data, quiet)

Arguments

name

Character string giving the module name.

path

Character string giving the location in which to save the downloaded module.

version

The module version to download. (If not specified, or NA, the most recent version will be retrieved.)

repo

GitHub repository name. Default is "PredictiveEcology/SpaDES-modules", which is specified by the global option spades.modulesRepo.

data

Logical. If TRUE, then the data that is identified in the module metadata will be downloaded, if possible. Default if FALSE.

quiet

Logical. This is passed to download.file. Default is FALSE.

Value

A list of length 2. The first elemet is a character vector containing a character vector of extracted files for the module. The second element is a tbl with details about the data that is relevant for the function, including whether it was downloaded or not, whether it was renamed (because there was a local copy that had the wrong file name).

Details

Currently only works with a public GitHub repository, where modules are in a modules directory in the root tree on the master branch.

NOTE: the default is to overwrite any existing files in the case of a conflict.