use_module: Create and setup a module folder.

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

Description

This function creates a new module inside the modules folder of an active r project. If the 'modules' folder doesn't exist it will create it then adds a new folder with the name as specified in the name argument inside the 'modules' folder. R scripts to be used across the module will be added which contain the following:

• a lgr logger script,

• a script that contains constant values, and

• a script for storing helper functions.

Since dymium modules use the 'modules' and 'checkmate' packages, if these packages are not installed the function will ask whether you would like to install them or not.

Note that, to add event functions to a module see use_event.

Usage

use_module(name)

Arguments

name	Name of the module.

Examples

## Not run: 
# Note: running this will create a folder called "modules" and a sub-folder
#       to your working directory within the folder called "demography"
use_module(name = "demography")

## End(Not run)

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