Skip to content

Guides

Task-oriented pages: everything that is not "which model should I use".

  • Configuration and ground truth

    simulate() returns the coefficients, latent times and cure status the frame cannot show — what a simulation study is actually about.

  • Baseline hazards

    The five hazard families every sampler draws from, and how to supply one of your own.

  • Censoring

    The two built-in mechanisms, hitting a target event rate, and applying a censoring distribution of your own.

  • Covariates

    Three different covariate schemes across the model families, and how to control each.

  • Summarising a dataset

    Event counts, follow-up, quality checks, and comparing several datasets at once.

  • Plotting

    Kaplan-Meier curves, stratified curves, hazard comparisons, covariate effects.

  • Exporting data

    CSV, JSON, Feather and RDS — and what a round trip loses.

  • Fitting models to the data

    lifelines, scikit-survival, scikit-learn and R.

  • Command line

    Generating and plotting without writing Python.

Runnable notebooks

Three worked notebooks live in the repository under examples/notebooks/, and open in a browser with no install through Binder:

Notebook Opens in Binder
Illness-death, intervals (cmm) Binder
Illness-death, panel (thmm) Binder
Time-dependent covariates (tdcm) Binder

The same directory also holds plain scripts — run_cphm.py, run_aft.py, run_competing_risks.py and others — that can be run directly from a checkout.