record_raw_object: Record an Arbitrary Object During a Simulation

View source: R/net.record.R

record_raw_objectR Documentation

Record an Arbitrary Object During a Simulation

Description

This function records any object during a simulation to allow its inspection afterward. The records are stored in dat[["raw.records"]] during the simulation, where dat is the main netsim_dat class object, and in the netsim object under the raw.records collections::queue object.

Usage

record_raw_object(dat, at, label, object)

Arguments

dat

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

at

The time where the recording happens.

label

The name to give to the recorded object.

object

The object to be recorded.

Details

See the "Time-Varying Parameters" section of the "Working With Model Parameters" vignette.

Value

The updated netsim_dat main list object.

Examples

## Not run: 

dat <- record_raw_object(dat, at, "a.df", data.frame(x = 2:200))
dat <- record_raw_object(dat, at, "a.message", "I recorded something")


## End(Not run)


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