emptyEventList: Blank (template) event list

Description Usage Arguments Format Details Value Author(s)

Description

Internal function called from spades, returning an empty event list.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
.emptyEventList(eventTime, moduleName, eventType, eventPriority)

.emptyEventListDT

.singleEventListDT

## S4 method for signature 'numeric,character,character,numeric'
.emptyEventList(eventTime,
  moduleName, eventType, eventPriority)

## S4 method for signature 'missing,missing,missing,missing'
.emptyEventList()

.emptyEventListCols

.emptyEventListObj

.emptyEventListNA

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.

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



Search within the SpaDES package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.