gtsummary: tbl_survival – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

tbl_survival

Creates table of univariate summary statistics for time-to-event endpoints

Description

Please use tbl_survfit. Function takes a survfit object as an argument, and provides a formatted summary of the results

Usage

tbl_survival(x, ...)

## S3 method for class 'survfit'
tbl_survival(
  x,
  times = NULL,
  probs = NULL,
  label = ifelse(is.null(probs), "{time}", "{prob*100}%"),
  level_label = "{level}, N = {n}",
  header_label = NULL,
  header_estimate = NULL,
  failure = FALSE,
  missing = "-",
  estimate_fun = NULL,
  ...
)

Arguments

`x`	A survfit object with a no stratification (e.g. `survfit(Surv(ttdeath, death) ~ 1, trial)`), or a single stratifying variable (e.g. `survfit(Surv(ttdeath, death) ~ trt, trial)`)
`...`	Not used
`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
`label`	String defining the label shown for the time or prob column. Default is `"{time}"` or `"{prob*100}%"`. The input uses glue::glue notation to convert the string into a label. A common label may be `"{time} Months"`, which would resolve to "6 Months" or "12 Months" depending on specified `times`.
`level_label`	Used when survival results are stratified. It is a string defining the label shown. The input uses glue::glue notation to convert the string into a label. The default is `"{level}, N = {n}"`. Other information available to call are `'{n}'`, `'{level}'`, `'{n.event.tot}'`, `'{n.event.strata}'`, and `'{strata}'`. See below for details.
`header_label`	String to be displayed as column header. Default is `'Time'` when `time` is specified, and `'Quantile'` when `probs` is specified.
`header_estimate`	String to be displayed as column header of the Kaplan-Meier estimate. Default is `'Probability'` when `time` is specified, and `'Time'` when `probs` is specified.
`failure`	Calculate failure probabilities rather than survival probabilities. Default is `FALSE`. Does NOT apply to survival quantile requests
`missing`	String indicating what to replace missing confidence limits with in output. Default is `missing = "-"`
`estimate_fun`	Function used to format the estimate and confidence limits. The default is `style_percent(x, symbol = TRUE)` for survival probabilities, and `style_sigfig(x, digits = 3)` for time estimates.

gtsummary

Presentation-Ready Data Summary and Analytic Result Tables

v1.4.0

MIT + file LICENSE

Authors

Daniel D. Sjoberg [aut, cre] (<https://orcid.org/0000-0003-0862-2018>), Michael Curry [aut] (<https://orcid.org/0000-0002-0261-4044>), Margie Hannum [aut] (<https://orcid.org/0000-0002-2953-0449>), Joseph Larmarange [aut] (<https://orcid.org/0000-0001-7097-700X>), Karissa Whiting [aut] (<https://orcid.org/0000-0002-4683-1868>), Emily C. Zabor [aut] (<https://orcid.org/0000-0002-1402-4498>), Esther Drill [ctb] (<https://orcid.org/0000-0002-3315-4538>), Jessica Flynn [ctb] (<https://orcid.org/0000-0001-8310-6684>), Jessica Lavery [ctb] (<https://orcid.org/0000-0002-2746-5647>), Stephanie Lobaugh [ctb], Gustavo Zapata Wainberg [ctb] (<https://orcid.org/0000-0002-2524-3637>)

Initial release

tbl_survival

Description

Usage

Arguments

gtsummary

We don't support your browser anymore