Kaplan-Meier estimator for simulation data — km

Estimates survival functions from simulated entity outcomes. Supports several endpoints for both output profiles.

Usage

km_estimate(
  data,
  scenarios = NULL,
  endpoint = c("stage2", "overall", "service", "regression", "completion", "phase_c"),
  stratify_by = "scenario",
  ci_method = "log",
  n_bootstrap = 0,
  seed = 42
)

Arguments

data: A dynasimR_data object or a tibble/data.frame containing entity-level columns.
scenarios: Character vector. Restrict to these scenario IDs. Default NULL = all.
endpoint: Character. One of "stage2", "overall", "service", "regression", "completion", "phase_c". The latter three are Profile-B-only endpoints.
stratify_by: Character vector. Strata variables, e.g. "scenario" or c("scenario", "group").
ci_method: Character. Passed to survival::survfit() as conf.type. Default "log".
n_bootstrap: Integer. Bootstrap replicates for KM CIs (0 = disabled). Default 0.
seed: Integer. RNG seed for bootstrap. Default 42.

Value

An S3 object of class dynasimR_km (list) with slots fit, tidy, logrank, median_survival, boot_ci and params.

Examples

if (FALSE) { # \dontrun{
sim <- load_example_data()
km <- km_estimate(sim, endpoint = "stage2",
                  stratify_by = "scenario")
print(km)
plot_km(km)
} # }