format.SurvivalAnalysisUnivariateResult: Formats a SurvivalAnalysisUnivariateResult for printing

In survivalAnalysis: High-Level Interface for Survival Analysis and Associated Plots

Description

Formats a SurvivalAnalysisUnivariateResult for printing

Usage

## S3 method for class 'SurvivalAnalysisUnivariateResult'
format(
  x,
  ...,
  label = NULL,
  p_precision = 3,
  hr_precision = 2,
  p_less_than_cutoff = 0.001,
  time_precision = 1,
  include_end_separator = FALSE,
  timespan_unit = c("days", "months", "years")
)

Arguments

x	The result generated by analyse_survival
...	Further arguments passed from other methods.
label	A label describing the result
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 "<..."
include_end_separator	Append "\n—\n"? Comes handy if printing multiple results following each other
timespan_unit	Unit for time spans: "days", "months" or "years".

Value

A formatted string, ready for output with cat()

survivalAnalysis documentation built on Feb. 11, 2022, 5:07 p.m.