outcomeInfo-class: Outcome information object.

outcomeInfo-classR Documentation

Outcome information object.

Description

An outcome information object stores data concerning an outcome. This is used to prospectively check data.

Slots

name

Name of the outcome, inherited from the original column name by default.

outcome_type

Type of outcome.

outcome_column

Name of the outcome column in data.

levels

Specifies class levels of categorical outcomes.

ordered

Specifies whether categorical outcomes are ordered.

reference

Class level used as reference.

time

Maximum time, as set by the time_max configuration parameter.

censored

Censoring indicators for survival outcomes.

event

Event indicators for survival outcomes.

competing_risk

Indicators for competing risks in survival outcomes.

distribution

Five-number summary (numeric outcomes), class frequency (categorical outcomes), or survival distributions.

data_id

Internal identifier for the dataset used to derive the outcome information.

run_id

Internal identifier for the specific subset of the dataset used to derive the outcome information.

transformation_parameters

Parameters used for transforming a numeric outcomes. Currently unused.

normalisation_parameters

Parameters used for normalising numeric outcomes. Currently unused.


familiar documentation built on Sept. 30, 2024, 9:18 a.m.