Skip to main content
Skip table of contents

getOutcomes

Get the list of all available outcomes.
The function returns a list containing the following elements:

output(character)Name of the output element on which the outcome is based.
perOccasion(logical)If occasions are present in the simulation, it indicates if the outcome is calculated for each id or each occasion of each id.

Then, if the outcome is based on a continuous or categorical output:

relativeTo(list)List of elements that define reference settings:
  • reference - one of "baseline", "min", "max", "minCurrentTime", "maxCurrentTime" or "customValue",

  • type - "ratio" or "difference",

  • value - if reference is "customValue".

processing(list)List of elements that define how the output will be processed:
  • operator - one of "avg", "min", "max", "first", "last", "durationBelow", "durationAbove", "durationBetween" or "timePoint",

  • type

    • if operator is "min" or "max", one of "value", "timeContinuous" or "timeEvent",

    • if operator is "durationBelow", "durationAbove" or "durationBetween", one of "cumulativeTime", "percentTime", "nbObs", "firstOccurenceContinuous" or "firstOccurenceEvent",

  • value - vector of boundaries if operator is "durationBelow", "durationAbove" or "durationBetween", or time point if operator is "timePoint".

applyThreshold(list)List of elements:
  • operator - one of "==", "!=", ">=", ">", "<=" or "<",

  • value - a real number indicating the threshold value.

Or if the outcome is based on a TTE output:

event(list)List of arguments that define event settings:
  • type - one of "timeOfEvents" (in case of repeated TTE), "hasAnEvent", "hasNoEvent" (in case of single TTE) or "numberOf" (in case of repeated TTE),

  • rank - rank of the event of which time is the outcome (if type is "timeOfEvents").

Usage

R
getOutcomes()

See also

Examples

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.