eventlist {dMod}R Documentation

Eventlist

Description

An eventlist is a data.frame with the necessary parameters to define an event as columns and specific events as rows. Event time and value can be passed as parameters, which can also be estimated.

Usage

eventlist(var = NULL, time = NULL, value = NULL, method = NULL)

addEvent(event, var, time = 0, value = 0, method = "replace", ...)

Arguments

var

Character, the state to which the event is applied

time

Character or Numeric, the time at which the event happens

value

Character or Numeric, the value of the event

method

Character, options are "replace", "add" or "multiply"

event

object of class eventlist

...

not used

Details

The function addEvent is pipe-friendly

Value

data.frame with class eventlist

Examples

eventlist(var = "A", time = "5", value = 1, method = "add")

events <- addEvent(NULL, var = "A", time = "5", value = 1, method = "add")
events <- addEvent(events, var = "A", time = "10", value = 1, method = "add")

[Package dMod version 1.0.2 Index]