NewEvent: Create an event which is used for processing the raw...

In scientific-computing-solutions/badminton: Simulation of Continuous-Time Discrete-Space Markov Chains

Description

Create an event which is used for processing the raw transition times

Usage

NewEvent(name, type, nodeNames = NULL, time = NULL, edges = NULL,
  calendarTime = FALSE)

Arguments

name	parameter will be used as column name for this event when calling ProcessEventSimOutput
type	There are a set of possible event types There are a set of different events, each described with example code "startState": NewEvent(name="colName",type="startState") will output the starting state for each patient "endState": NewEvent(name="colName",type="endState") will output the final state each patient transitioned into "recruitTime": NewEvent(name="colName",type="recruitTime") will output the (calendar) time at which the patient was recruited onto the trial "timeToHit": NewEvent(name="colName",type="timeToHit",nodeNames=c("n1","n2")) will output the time at which patients first transition into any node in nodeNames argument. If the none of the nodes are transitioned into then Inf is output "hitsBefore": NewEvent(name="colName",type="hitsBefore",nodeNames=c("n1","n2"),time=5) will output whether the patients first transition into any node in nodeNames argument before the given time "timeToHit_Edge": NewEvent(name="colName",type="timeToHit_Edge",edges=c("from_1","to_1","from_2","to_2")) will output the time at which patients first transition across any of the given edges. In this example the edges from_1,to_1 and from_2,to_2. If the none of the edges are traversed then Inf is output "hitsBefore_Edge": NewEvent(name="colName",type="hitsBefore_Edge",edges=c("from_1","to_1","from_2","to_2"),time=Inf) will output whether any of the edges have been traversed before the given Time
nodeNames	The node list for timeToHit and hitsBefore event types
time	The time before which hitsBefore or hitsBefore_Edge events must occur for "TRUE" to be output. This is a strict inequality so using the time Inf will display TRUE iff the event occurs at any time. If calendarTime is TRUE then this time represents calendar time otherwise it represents patient time.
edges	The edge list for timeToHit_Edge and hitsBefore_Event event types. It is of the form c("from_1","to_1","from_2","to_2")
calendarTime	If true then time and the associated output for this event are calendar times, if false they are patient times

Value

An Event object

scientific-computing-solutions/badminton documentation built on May 29, 2019, 3:43 p.m.