Survival analysis in Python, including Kaplan Meier, Nelson Aalen and regression
Project description
What is survival analysis and why should I learn it? Survival analysis was originally developed and applied heavily by the actuarial and medical community. Its purpose was to answer why do events occur now versus later under uncertainty (where events might refer to deaths, disease remission, etc.). This is great for researchers who are interested in measuring lifetimes: they can answer questions like what factors might influence deaths?
But outside of medicine and actuarial science, there are many other interesting and exciting applications of this survival analysis. For example:
- SaaS providers are interested in measuring customer lifetimes, or time to first behaviours
- inventory stockout is a censoring event for true "demand" of a good.
- sociologists are interested in measuring political parties' lifetimes, or relationships, or marriages
- analysing Godwin's law in Reddit comments
- A/B tests to determine how long it takes different groups to perform an action.
lifelines is a pure Python implementation of the best parts of survival analysis. We'd love to hear if you are using lifelines, please leave an Issue and let us know your thoughts on the library.
Installation:
You can install lifelines using
pip install lifelines
Or getting the bleeding edge version with:
pip install --upgrade --no-deps git+https://github.com/CamDavidsonPilon/lifelines.git
from the command line.
Installation Issues?
See the common problems/solutions for installing lifelines.
Running the tests
You can optionally run the test suite after install with
py.test
lifelines Documentation and an intro to survival analysis
If you are new to survival analysis, wondering why it is useful, or are interested in lifelines examples, API, and syntax, please check out the Documentation and Tutorials page
Example:
from lifelines import KaplanMeierFitter
durations = [11, 74, 71, 76, 28, 92, 89, 48, 90, 39, 63, 36, 54, 64, 34, 73, 94, 37, 56, 76]
event_observed = [True, True, False, True, True, True, True, False, False, True, True,
True, True, True, True, True, False, True, False, True]
kmf = KaplanMeierFitter()
kmf.fit(durations, event_observed)
kmf.plot()
Contacting & troubleshooting
- There is a Gitter channel available.
- Some users have posted common questions at stats.stackexchange.com
- creating an issue in the Github repository.
Roadmap
You can find the roadmap for lifelines here.
Development
Setting up a lifelines development environment
- From the root directory of
lifelinesactivate your virtual environment (if you plan to use one). - Install the development requirements and
pre-commithooks. If you are on Mac, Linux, or WindowsWSLyou can use the providedMakefile. Just typemakeinto the console and you're ready to start developing.
Formatting
lifelines uses the black python formatter.
There are 3 different ways to format your code.
- Use the
Makefile.make format
- Call
blackdirectly and pass the correct line length.black . -l 120
- Have you code formatted automatically during commit with the
pre-commithook.- stage and commit your unformatted changes:
git commit -m "your_commit_message" - Code that needs to be formatted will "fail" the commit hooks and be formatted for you.
- Stage the newly formatted python code:
git add *.py - Recall your original commit command and commit again:
git commit -m "your_commit_message"
- stage and commit your unformatted changes:
Citing lifelines
You can use this badge below to generate a DOI and reference text for the latest related version of lifelines:
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
File details
Details for the file lifelines-0.19.0.tar.gz.
File metadata
- Download URL: lifelines-0.19.0.tar.gz
- Upload date:
- Size: 460.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 41738b72abd32be2944074b392acc40d31e0cc2fc200e8b6a8b260ab9c62c96e |
|
| MD5 | 496a36cea2cf98a14fcc5b7309ec789d |
|
| BLAKE2b-256 | fa15693a7eda17ced08b4552215ec0b3dd149538bb26f92db34942f4628e1b64 |
File details
Details for the file lifelines-0.19.0-py3-none-any.whl.
File metadata
- Download URL: lifelines-0.19.0-py3-none-any.whl
- Upload date:
- Size: 255.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 749cb9bb18b17b49b73487ada1e0b6cf11b4dd0e3e20210dd51a51b44552051f |
|
| MD5 | 46477da0483bfdfe249d0d066d09a207 |
|
| BLAKE2b-256 | 5cdace71cd5f8ce83d1f655fe414a77448b2c99bbd2ea666f7ee060414f9f1c4 |
File details
Details for the file lifelines-0.19.0-py2.py3-none-any.whl.
File metadata
- Download URL: lifelines-0.19.0-py2.py3-none-any.whl
- Upload date:
- Size: 255.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3cd08143e369c465446b6420f78f83a219eb6622b664ab44a90d5e5d5a167758 |
|
| MD5 | 4773ceeddf46b1d2123338bc3ca2bc45 |
|
| BLAKE2b-256 | eecb1d6304f96df3273afc8a1b4d678af68a22fbfa16e8c63e0483f9402d567b |
