survivalAnalysis (version 0.3.0)

print.SurvivalAnalysisUnivariateResult: Print the essentials of a SurvivalAnalysisUnivariateResult

Description

Print the essentials of a SurvivalAnalysisUnivariateResult

Usage

# S3 method for SurvivalAnalysisUnivariateResult
print(
  x,
  ...,
  label = NULL,
  p_precision = 3,
  hr_precision = 2,
  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

Precision with which to print floating point values

hr_precision

Precision with which to print floating point values

time_precision

Precision with which to print floating point values

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

The formatted string, invisibly.