vars {SimEngine} | R Documentation |
Access internal simulation variables
Description
This is a "getter function" that returns the value of an internal simulation variable. Do not change any of these variables manually.
Usage
vars(sim, var)
Arguments
sim | A simulation object of class sim_obj, usually created by new_sim |
var | If this argument is omitted, vars will return a list containing all available internal variables. If this argument is provided, it should equal one of the following character strings:
|
Details
You can also access simulation variables through sim$vars, where sim is your simulation object (see examples).
Value
The value of the internal variable.
Examples
sim <- new_sim()
sim %<>% set_levels(
"n" = c(10, 100, 1000)
)
sim %<>% set_config(num_sim=10)
vars(sim, "num_sim_total") %>% print()
sim$vars$num_sim_total %>% print()
vars(sim) %>% print()