easysurv (version 2.0.1)

inspect_surv_data: Inspect Survival Data

Description

Quickly inspect the survival data to ensure it is in the correct format.

Usage

inspect_surv_data(data, time, event, group = NULL)

Value

A list containing tibbles that summarise the first few rows of the survival data, the sample sizes, the events, and median survival.

Arguments

data

A data frame containing the survival data.

time

The column name in data containing the time-to-event data.

event

The column name in data containing the event indicator data.

group

Optional. The column name in data containing the group indicator data.

Examples

inspect_surv_data(
  data = easysurv::easy_bc,
  time = "recyrs",
  event = "censrec",
  group = "group"
)