14.5 TreeAge Pro Keywords

Keywords are reserved values auto-generated by TreeAge Pro that can be accessed within your model. You do not need to define them, you just use them at the appropriate place for the calculation or logical statement you are completing.

(Note that some of these Keywords are not used in Business or Legal models but they are used in Healthcare models. We leave the list here for completeness).

Keyword

Description

 

_stage Markov cycle counter (starts with 0)
_tunnel Markov cycle-in-state counter (starts with 1), requires state to be configured with tunnel max value
_state_index Index for the Markov state counting down from the top (top state is 1, next down is 2, etc.)
_strategy Returns the number of the strategy, defined as a branch directly coming from a decision node (numbered top to bottom). The value is undefined to the left of the first decision node or if the model has no decision node.
_trial Index for the trial/iteration being processed in the Microsimulation loop of a simulation (always 1 when not running Microsimulation)
_trial_size Number of trials/iterations for the Microsimulation loop
_sample Index for the sample/iteration being processed in the sampling/PSA loop of a simulation (always 1 when not running PSA)
_sample_size Number of samples/iterations for the PSA simulation loop
_voi_sample Index for the value of information (VOI) iteration being processed, the outer most simulation loop in EVPPI analysis (always 1 when not running EVPPI)
_voi_sample_size Number of iterations for the outer most simulation loop in EVPPI analysis
_node_id Returns the numeric identifier for a specific node
_node_label Returns the label for a specific node
_thread_index Index for the thread which is running all or a portion of the overall simulation (simulations can run as multiple threads to increase the speed of the simulation)
_parallel_trials_clock The current _clock value during a parallel trials discrete event simulation that uses the _CLOCK value to keep the trials synchronized.
_parallel_trial_creator If you turn off probability coherence, you can create individuals in a parallel trials simulation. This keyword can be used by a new trial to get the number of the trial that created it (i.e., via a transition/chance event with non-coherent probs).
_parallel_trials_set The index for the current set of parallel trials.
_parallel_trials_sets_size The number of sets of parallel trials in the simulation.
_cache_level When using the Node() function to access parts of the tree, this returns the "depth" of the calls from nested Node() functions.