AddArm.ProgressionGraph: Allows an entire arm to be added to an object of type...

Description Usage Arguments Value

View source: R/progressionGraph.R

Description

Allows an entire arm to be added to an object of type ProgressionGraph The Weibull shape parameter for the rates for each node will be 1, to change use SetShape.ProgressionGraph

Usage

1
2
AddArm.ProgressionGraph(object, armName, armProgression, deathNode = "death",
  edges = "immediate", visitSchedule = NULL, isVisitNode = FALSE)

Arguments

object

the ProgressionGraph to add the new arm

armName

the name of the arm, for example "control"

armProgression

a vector of states subjects experience for example "progressing", "progressed". This vector should not include the "death" state

deathNode

the name of the death node in the graph, which should already exist

edges

determines which edges are to be added for arm must be one of "none","immediate","death","all". none: no edges added immediate: must progress sequentially through all states death: must progress sequentially through all states or go straight to death all: can jump straight to any state (always progressing towards death)

visitSchedule

Either a VisitSchedule object which is the visit schedule to be used for the nodes of this arm or NULL if no visit schedule is being used (or visit Schedule is to be added later)

isVisitNode

A logical value: Are the new node ‘visit’ nodes, i.e. nodes for which the transition into it is unknown until the next visit

Value

a new ProgressionGraph with the arm added. The new nodes will be of the form armName.armProgression[i]


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