Download a .zip file of the module and extract (unzip) it to a user-specified location.
downloadModule( name, path, version, repo, data, quiet, quickCheck = FALSE, overwrite = FALSE ) # S4 method for character,character,character,character,logical,logical,ANY,logical downloadModule( name, path, version, repo, data, quiet, quickCheck = FALSE, overwrite = FALSE ) # S4 method for character,missing,missing,missing,missing,missing,ANY,ANY downloadModule(name, quickCheck, overwrite) # S4 method for character,ANY,ANY,ANY,ANY,ANY,ANY,ANY downloadModule( name, path, version, repo, data, quiet, quickCheck = FALSE, overwrite = FALSE )
Character string giving the module name.
Character string giving the location in which to save the downloaded module.
The module version to download. (If not specified, or
the most recent version will be retrieved.)
GitHub repository name, specified as
"PredictiveEcology/SpaDES-modules", which is
specified by the global option
master branches can be used at this point.
TRUE, then the data that is identified in the
module metadata will be downloaded, if possible. Default
Logical. This is passed to
TRUE, then the check with local data will only
file.size instead of
This is faster, but potentially much less robust.
Logical. Should local module files be overwritten in case they exist?
A list of length 2. The first element is a character vector containing
a character vector of extracted files for the module. The second element is
tbl with details about the data that is relevant for the function,
including whether it was downloaded or not, and whether it was renamed
(because there was a local copy that had the wrong file name).
Currently only works with GitHub repositories where modules are located in
modules directory in the root tree on the
Module .zip files' names should contain the version number and be inside their
respective module folders (see
zipModule for zip compression of modules).
downloadModule uses the
GITHUB_PAT environment variable
if a value is set. This alleviates 403 errors caused by too-frequent downloads.
Generate a GitHub personal access token with no additional permissions at
https://github.com/settings/tokens, and add this key to
The default is to overwrite any existing files in the case of a conflict.
zipModule for creating module .zip folders.