Skip to contents

Summarize the data in a survfit object

Source: R/summarise_KM.R
summarise_KM.Rd

This function takes a survival object generated from a call to survfit and produces a concise summary table.

Usage

summarise_KM(fit, strata_labels = NULL)

summarize_KM(fit, strata_labels = NULL)

Arguments

fit

A survival object generated from a call to survfit.

strata_labels

Optional parameter to rename the group column (if multiple strata)

Value

A data frame summarizing the data in the survival object. The table includes information about the strata, number of observations, number of events, restricted mean survival times, median survival times, and corresponding confidence intervals.

Examples

if (FALSE) {
library(survival)

# Example usage with lung data
fit <- survfit(Surv(time, status) ~ as.factor(sex), data = lung)
summarise_KM(fit)
}