modules/test/README.md

In dymium-org/dymiumModules: A utility package for `dymium` module management

• test module documentation
• Release notes
  • Version 0.1
• Requirements
• Events
  • Event name 1
  • Event name 2
• Known issues

test module documentation

• Authors: Your name
• Email: [e-mail]
• Current version: 0.0.2

This module provides the following functionalities…

Release notes

Version 0.1

This is the first version of this module.

Requirements

This module requires the following packages … and external dependecies such as …

Events

Event name 1

Usage

event_test_eventname <- modules::use("modules/test/eventname.R")
event_test_eventname$run(world, model = NULL, target = NULL, time_steps = NULL)

Params

• world: a World object.
• model: a named list.

# For example
model <- list(x1 = list(yes = 0.5, no = 0.5),
              x2 = data.table(sex = c("male", "female"), prob = c(0.2, 0.1)))

• target: a named list.
• time_steps: a numeric vector that indicates the time steps in the simulation clock that this event should be run.

Description

This event does..

Note

Here are some assumptions and settings that you should know about this event..

Example

1 + 1

Event name 2

Usage

event_test_eventname <- modules::use("modules/test/eventname.R")
event_test_eventname$run(world, model = NULL, target = NULL, time_steps = NULL)

Params

• world: a World object.
• model: a named list.

# For example
model <- list(x1 = list(yes = 0.5, no = 0.5),
              x2 = data.table(sex = c("male", "female"), prob = c(0.2, 0.1)))

• target: a named list.
• time_steps: a numeric vector that indicates the time steps in the simulation clock that this event should be run.

Description

This event does..

Note

Here are some assumptions and settings that you should know about this event..

Example

1 + 1

Known issues

Here are some known issues

dymium-org/dymiumModules documentation built on May 23, 2020, 10:30 a.m.