survivalAnalysis (version 0.3.0)

survival_data_frames: Extract results from univariate survival analysis structured as data frames

Description

Extract results from univariate survival analysis structured as data frames

Usage

survival_data_frames(
  result,
  format_numbers = TRUE,
  p_precision = 3,
  hr_precision = 2,
  p_less_than_cutoff = 0.001,
  time_precision = 1,
  timespan_unit = c("days", "months", "years")
)

Arguments

result

The result generated by analyse_survival

format_numbers

If true, all numbers will be formatted for printing according to the following options and will be returned as strings

p_precision, hr_precision, time_precision

Precision with which to print floating point values

p_less_than_cutoff

Cut-off for small p values. Values smaller than this will be displayed like "<..."

timespan_unit

Unit for time spans: "days", "months" or "years".

Value

A named list list of data frame objects:

• cohortMetadata: information about the full cohort

• if there are strata (analysis performed "by" a covariate):

  • strataMetadata: information about each stratum

  • hazardRatios: hazard ratios for combinations of strata

  • only if there are more than two strata:

    • pairwisePValues: Matrix of pairwise (uncorrected) p values