tbl_survfit: Creates table of survival probabilities

Description

lifecycle::badge("maturing") Function takes a survfit object as an argument, and provides a formatted summary table of the results

Usage

tbl_survfit(x, ...)
# S3 method for list
tbl_survfit(
  x,
  times = NULL,
  probs = NULL,
  statistic = NULL,
  label = NULL,
  label_header = NULL,
  estimate_fun = NULL,
  missing = NULL,
  conf.level = 0.95,
  reverse = FALSE,
  quiet = NULL,
  ...
)
# S3 method for survfit
tbl_survfit(x, ...)
# S3 method for data.frame
tbl_survfit(x, y, include = everything(), ...)

Arguments

x: a survfit object, list of survfit objects, or a data frame. If a data frame is passed, a list of survfit objects is constructed using each variable as a stratifying variable.
...: For tbl_survfit.data.frame() and tbl_survfit.survfit() the arguments are passed to tbl_survfit.list(). They are not used when tbl_survfit.list() is called directly.
times: numeric vector of times for which to return survival probabilities.
probs: numeric vector of probabilities with values in (0,1) specifying the survival quantiles to return
statistic: string defining the statistics to present in the table. Default is "{estimate} ({conf.low}, {conf.high})"
label: List of formulas specifying variables labels, e.g. list(age ~ "Age, yrs", stage ~ "Path T Stage"), or a string for a single variable table.
label_header: string specifying column labels above statistics. Default is "{prob} Percentile" for survival percentiles, and "Time {time}" for n-year survival estimates
estimate_fun: function to format the Kaplan-Meier estimates. Default is style_percent() for survival probabilities and style_sigfig for survival times
missing: text to fill when estimate is not estimable. Default is "--"
conf.level: Confidence level for confidence intervals. Default is 0.95
reverse: Flip the probability reported, i.e. 1 - estimate. Default is FALSE. Does not apply to survival quantile requests
quiet: Logical indicating whether to print messages in console. Default is FALSE
y: outcome call, e.g. y = Surv(ttdeath, death)
include: Variable to include as stratifying variables.