Adds a new event to the simulation's conditional event queue,
updating the simulation object by creating or appending to
sim$._conditionalEvents
. This is very experimental. Use with caution.
scheduleConditionalEvent( sim, condition, moduleName, eventType, eventPriority = .pkgEnv$.normalVal, minEventTime = start(sim), maxEventTime = end(sim) )
sim | A |
---|---|
condition | A string, call or expression that will be assessed for |
moduleName | A character string specifying the module from which to
call the event. If missing, it will use
|
eventType | A character string specifying the type of event from within the module. |
eventPriority | A numeric specifying the priority of the event.
Lower number means higher priority. As a best practice, it is
recommended that decimal values are conceptual
grouped by their integer values (e.g., 4.0, 4.25, 4.5 are conceptually
similar).
See |
minEventTime | A numeric specifying the time before which the event should not occur,
even if the condition is met. Defaults to |
maxEventTime | A numeric specifying the time after which the event should not occur,
even if the condition is met. Defaults to |
Returns the modified simList
object, i.e., sim$._conditionalEvents
.
This conditional event queue will be assessed at every single event in the normal event
queue. If there are no conditional events, then spades
will proceed as normal.
As conditional event conditions are found to be true, then it will trigger a call to
scheduleEvent(...)
with the current time passed to eventTime
and
it will remove the conditional event from the conditional queue.
If the user would like the triggered conditional event to occur as the very next event,
then a possible strategy would be to set eventPriority
of the conditional event
to very low or even negative to ensure it gets inserted at the top of the event queue.
Matloff, N. (2011). The Art of R Programming (ch. 7.8.3). San Francisco, CA: No Starch Press, Inc.. Retrieved from https://nostarch.com/artofr.htm
Eliot McIntire
#>#> #> #> #> #> #> #>condition <- "sim$age > 1" # provide as string condition <- quote(sim$age > 1) # provide as a call condition <- expression(sim$age > 1) # provide as an expression sim <- scheduleConditionalEvent(sim, condition, "firemodule", "burn") conditionalEvents(sim)#> condition minEventTime maxEventTime moduleName eventType eventPriority #> 1: sim$age > 1 0 2 firemodule burn 5#>#> total elpsd: 0.0042 secs | 0 save init 0#> total elpsd: 0.0066 secs | 0 progress init 0#> total elpsd: 0.0088 secs | 0 load init 0#> simList saved in #> SpaDES.core:::.pkgEnv$.sim #>#> Null data.table (0 rows and 0 cols)sim$age <- 2 # change the value sim <- spades(sim) # Run spades, the condition is now true, so event is#>#> simList saved in #> SpaDES.core:::.pkgEnv$.sim #>#> eventTime moduleName eventType eventPriority #> 1: 2 firemodule burn 5