emptyEventList {SpaDES.core} | R Documentation |
Blank (template) event list
Description
Internal function called from spades
, returning an empty event list.
Usage
.emptyEventListDT
.singleEventListDT
.emptyEventList(eventTime, moduleName, eventType, eventPriority)
## S4 method for signature 'numeric,character,character,numeric'
.emptyEventList(eventTime, moduleName, eventType, eventPriority)
## S4 method for signature 'missing,missing,missing,missing'
.emptyEventList()
.emptyEventListCols
Arguments
eventTime |
The time the event is to occur. |
moduleName |
The module from which the event is taken. |
eventType |
A character string for the programmer-defined event type. |
eventPriority |
The priority given to the event. |
Format
An object of class data.table
(inherits from data.frame
) with 0 rows and 4 columns.
An object of class data.table
(inherits from data.frame
) with 1 rows and 4 columns.
An object of class character
of length 4.
Details
Event lists are sorted (keyed) first by time, second by priority.
Each event is represented by a data.table()
row consisting of:
eventTime | The time the event is to occur. |
moduleName | The module from which the event is taken. |
eventType | A character string for the programmer-defined event type. |
eventPriority | The priority given to the event. |
Value
Returns an empty event list.
Author(s)
Alex Chubaty
[Package SpaDES.core version 2.1.0 Index]