InsertRate.EventSim: Insert a transition rate into 'EventSim' object

Description Usage Arguments Value

View source: R/eventSim.R

Description

Add a numeric value or function as the transition rate for an edge of the DAG for a specific patient and calendar time. If a rate already exists for this edge, patient and calendar time then the previous value is overwritten. See the Vignette for further details.

Usage

1
2
InsertRate.EventSim(object, fromNode, toNode, calendarStartTime = NULL,
  patientStartTime = NULL, rate)

Arguments

object

The EventSim object this rate is to be added into.

fromNode

The rate being added is for subjects leaving this node (i.e. state) entering toNode. The node should be a string matching a node name in object$progressionGraph

toNode

The rate being added is for subjects arriving into this node from toNode. The node should be a string matching a node name in object$progressionGraph

calendarStartTime

The calendar start time for this rate to be used. The rate will only be used from this time until the next calendar time switch. If NULL this rate is used for all calendar start times. Note calendar start time must match a calendar time in object$Switches

patientStartTime

The patient start time for this rate to be used

rate

Transition rate. Either a (non-negative) value or a function. See Vignette for further details

Value

object with the appropriate rates added


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