survivalAnalysis (version 0.3.0)

survival_essentials: Convenience formatting and printing of result

Description

Takes the given result, formats and prints it

Usage

survival_essentials(
  result,
  label = NULL,
  p_precision = 3,
  hr_precision = 2,
  time_precision = 1,
  include_end_separator = TRUE,
  timespan_unit = "days",
  print = TRUE
)

Arguments

result

The result generated by analyse_survival

label

Optional label to include

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".

print

Print string to console

Value

The formatted string, invisibly. Ready for output with cat or saving to a file.