stateprobs: State probability object
In hesim: Health Economic Simulation Modeling and Decision Analysis
stateprobs R Documentation
State probability object
Description
An object of class stateprobs returned by sim_stateprobs() or from
$sim_stateprobs() methods in model classes.
Components
A stateprobs object inherits from data.table and contains
the following columns:
- sample
A random sample from the PSA.
- strategy_id
The treatment strategy ID.
- patient_id
The patient ID.
- grp_id
The subgroup ID.
- state_id
The health state ID.
- t
The time at which a state probability is computed.
- prob
The probability of being in a given health state.
When simulating individual-level models, the patient_id column is
not included as state probabilities are computed by averaging across patients.
In cohort models, the object also contains size and absorbing attributes.
The size attribute is a numeric vector with the elements n_samples,
n_strategies, n_patients, n_states, and
n_times denoting the number of samples, treatment strategies, patients,
health states, and times. The absorbing attribute is a numeric vector
containing the absorbing health states (see the absorbing field of the
CohortDtstmTrans class for more details).
hesim documentation built on Nov. 5, 2025, 6:52 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| stateprobs | R Documentation |
State probability object
Description
An object of class stateprobs returned by sim_stateprobs() or from
$sim_stateprobs() methods in model classes.
Components
A stateprobs object inherits from data.table and contains
the following columns:
- sample
A random sample from the PSA.
- strategy_id
The treatment strategy ID.
- patient_id
The patient ID.
- grp_id
The subgroup ID.
- state_id
The health state ID.
- t
The time at which a state probability is computed.
- prob
The probability of being in a given health state.
When simulating individual-level models, the patient_id column is
not included as state probabilities are computed by averaging across patients.
In cohort models, the object also contains size and absorbing attributes.
The size attribute is a numeric vector with the elements n_samples,
n_strategies, n_patients, n_states, and
n_times denoting the number of samples, treatment strategies, patients,
health states, and times. The absorbing attribute is a numeric vector
containing the absorbing health states (see the absorbing field of the
CohortDtstmTrans class for more details).
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.