set_current_timestep: Set the Current Timestep

View source: R/net.helpers.R

set_current_timestepR Documentation

Set the Current Timestep

Description

Changes the current timestep in the netsim_dat object. Use with caution. This function exists to work around unforeseen corner cases. In most situation, increment_timestep is preferred.

Usage

set_current_timestep(dat, timestep)

Arguments

dat

Main netsim_dat object containing a networkDynamic object and other initialization information passed from netsim.

timestep

The new value for the timestep.

Value

The updated netsim_dat main list object.

Mutability

This DOES NOT modify the netsim_dat object in place. The result must be assigned back to dat in order to be registered: dat <- increment_timestep(dat).


EpiModel documentation built on Oct. 12, 2024, 1:06 a.m.