Skip to contents

Simulate from a simulator

Source: R/simulate.R
simulate.Rd

Simulate from a simulator

Usage

simulate(simulator, values = NULL)

Arguments

simulator

Simulator object, initialized using make_simulator()

values

Complete list of model values to update the model simulator before generating the simulation. Must match format of params list from default (output of get_default_values() for desired model). If NULL, use values as currently attached to the model simulator.

Value

A data frame containing simulation results with columns

  • time: time in days from simulation start

  • state_name: compartment name

  • value_type: type of values, such as state (count of individuals in a compartment) and total_inflow (total inflow into a compartment)

  • value