download_module: Download a module from a repository.

In dymium-org/dymiumCore: A Toolkit for Building a Dynamic Microsimulation Model for Integrated Urban Modelling

Description

Download and extract a module to the 'modules' folder in the active working directory. If you are using an RStudio project then it will be saved in the 'modules' folder of your project. If the 'modules' folder does not exist, it will be created.

Usage

download_module(
  name,
  repo = dymiumModulesRepo,
  version,
  force = FALSE,
  remove_download = FALSE,
  .basedir = here::here()
)

Arguments

name	name of the module.
repo	A GitHub repository to look for modules. By default, this uses 'dymium-org/dymiumModules'.
version	the version of the module to download. If not given, the latest version will be downloaded.
force	A logical value. force download even though the module already exists locally.
remove_download	a logical value whether to delete the downloaded zip file or not.
.basedir	:: character(1) The base directory that the downloaded module will be saved at. here::here() is used to provide the default value which is is the root folder of the active RStudio project.

Value

path to the module.

Examples

## Not run: 
# download an test module.
download_modules("test", version = "0.0.1")

## End(Not run)

dymium-org/dymiumCore documentation built on July 18, 2021, 5:10 p.m.