tpmatrix_names: Names for elements of a transition probability matrix

In hesim: Health Economic Simulation Modeling and Decision Analysis

Names for elements of a transition probability matrix

Description

Create names for all elements of a transition probability matrix given names for the health states. This is useful for flattening a transition probability matrix (rowwise) into a vector and naming the resulting vector. The name of an element of the flattened vector representing a transition from the ith state to the jth state is of the form paste0(prefix, states[i], sep, states[j]).

Usage

tpmatrix_names(states, prefix = "p_", sep = "_")

Arguments

states	A character vector of the names of health states in the transition matrix.
prefix	A prefix that precedes the described transitions between states used to name a transition. For example, if prefix = "p_" (and sep = "_"), then a transition between state i and state j will be of the form "p_states[i]_states[j]"; similarly, if prefix = "", then the same transition will be named "states[i]_states[j]".
sep	A character string to separate the terms representing state i and state j. For instance, if sep = ".", the resulting name will be of the form "states[i].states[j]".

Value

A character vector containing a name for each element of the transition probability matrix encompassing all possible transitions.

See Also

See tpmatrix(), which uses tpmatrix_names() to name the columns of the returned object.

Examples

tpmatrix_names(LETTERS[1:4])
tpmatrix_names(LETTERS[1:4], prefix = "")
tpmatrix_names(LETTERS[1:4], prefix = "", sep = ".")

hesim documentation built on Sept. 4, 2022, 1:06 a.m.