Survival analysis in Python, including Kaplan Meier, Nelson Aalen and regression
Project description
.. figure:: http://i.imgur.com/EOowdSD.png
:alt:
|PyPI version| |Build Status| |Coverage Status| |Join the chat at
https://gitter.im/python-lifelines/Lobby| |DOI|
`What is survival analysis and why should I learn
it? <http://lifelines.readthedocs.org/en/latest/Survival%20Analysis%20intro.html>`__
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 lesser-known technique,
for example: - SaaS providers are interested in measuring customer
lifetimes, or time to first behaviours - sociologists are interested in
measuring political parties' lifetimes, or relationships, or marriages -
analysing `Godwin's
law <https://raw.githubusercontent.com/lukashalim/GODWIN/master/Kaplan-Meier-Godwin.png>`__
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 <https://github.com/CamDavidsonPilon/lifelines/issues?utf8=%E2%9C%93&q=label%3Ainstallation+>`__.
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 <http://lifelines.readthedocs.org/en/latest/index.html>`__
Example:
.. code:: python
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 <https://gitter.im/python-lifelines/>`__ channel
available.
- Some users have posted common questions at
`stats.stackexchange.com <https://stats.stackexchange.com/search?tab=votes&q=%22lifelines%22%20is%3aquestion>`__
- creating an issue in the `Github
repository <https://github.com/camdavidsonpilon/lifelines>`__.
Roadmap
~~~~~~~
You can find the roadmap for lifelines
`here <https://www.notion.so/camdp/6e2965207f564eb2a3e48b5937873c14?v=47edda47ab774ca2ac7532bb0c750559>`__.
Citing lifelines
~~~~~~~~~~~~~~~~
You can use this badge below to generate a DOI and reference text for
the latest related version of lifelines:
|DOI|
.. |PyPI version| image:: https://badge.fury.io/py/lifelines.svg
:target: https://badge.fury.io/py/lifelines
.. |Build Status| image:: https://travis-ci.org/CamDavidsonPilon/lifelines.svg?branch=master
:target: https://travis-ci.org/CamDavidsonPilon/lifelines
.. |Coverage Status| image:: https://coveralls.io/repos/github/CamDavidsonPilon/lifelines/badge.svg?branch=master
:target: https://coveralls.io/github/CamDavidsonPilon/lifelines?branch=master
.. |Join the chat at https://gitter.im/python-lifelines/Lobby| image:: https://badges.gitter.im/python-lifelines/Lobby.svg
:target: https://gitter.im/python-lifelines/Lobby
.. |DOI| image:: https://zenodo.org/badge/12420595.svg
:target: https://zenodo.org/badge/latestdoi/12420595
:alt:
|PyPI version| |Build Status| |Coverage Status| |Join the chat at
https://gitter.im/python-lifelines/Lobby| |DOI|
`What is survival analysis and why should I learn
it? <http://lifelines.readthedocs.org/en/latest/Survival%20Analysis%20intro.html>`__
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 lesser-known technique,
for example: - SaaS providers are interested in measuring customer
lifetimes, or time to first behaviours - sociologists are interested in
measuring political parties' lifetimes, or relationships, or marriages -
analysing `Godwin's
law <https://raw.githubusercontent.com/lukashalim/GODWIN/master/Kaplan-Meier-Godwin.png>`__
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 <https://github.com/CamDavidsonPilon/lifelines/issues?utf8=%E2%9C%93&q=label%3Ainstallation+>`__.
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 <http://lifelines.readthedocs.org/en/latest/index.html>`__
Example:
.. code:: python
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 <https://gitter.im/python-lifelines/>`__ channel
available.
- Some users have posted common questions at
`stats.stackexchange.com <https://stats.stackexchange.com/search?tab=votes&q=%22lifelines%22%20is%3aquestion>`__
- creating an issue in the `Github
repository <https://github.com/camdavidsonpilon/lifelines>`__.
Roadmap
~~~~~~~
You can find the roadmap for lifelines
`here <https://www.notion.so/camdp/6e2965207f564eb2a3e48b5937873c14?v=47edda47ab774ca2ac7532bb0c750559>`__.
Citing lifelines
~~~~~~~~~~~~~~~~
You can use this badge below to generate a DOI and reference text for
the latest related version of lifelines:
|DOI|
.. |PyPI version| image:: https://badge.fury.io/py/lifelines.svg
:target: https://badge.fury.io/py/lifelines
.. |Build Status| image:: https://travis-ci.org/CamDavidsonPilon/lifelines.svg?branch=master
:target: https://travis-ci.org/CamDavidsonPilon/lifelines
.. |Coverage Status| image:: https://coveralls.io/repos/github/CamDavidsonPilon/lifelines/badge.svg?branch=master
:target: https://coveralls.io/github/CamDavidsonPilon/lifelines?branch=master
.. |Join the chat at https://gitter.im/python-lifelines/Lobby| image:: https://badges.gitter.im/python-lifelines/Lobby.svg
:target: https://gitter.im/python-lifelines/Lobby
.. |DOI| image:: https://zenodo.org/badge/12420595.svg
:target: https://zenodo.org/badge/latestdoi/12420595
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
lifelines-0.15.0.tar.gz
(1.2 MB
view details)
Built Distributions
lifelines-0.15.0-py3-none-any.whl
(227.4 kB
view details)
File details
Details for the file lifelines-0.15.0.tar.gz.
File metadata
- Download URL: lifelines-0.15.0.tar.gz
- Upload date:
- Size: 1.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.19.5 CPython/3.6.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2ee1ec3a9cfa55e28311b07da10f7ffd7a539093d0bcd3366bc758a8e99875af |
|
| MD5 | d8001495a9570497bb4fdcfbe66cf114 |
|
| BLAKE2b-256 | aecc9b599b598268c9094f686d8c29ef406f981469e75831c29c8afab6d7d19a |
File details
Details for the file lifelines-0.15.0-py3-none-any.whl.
File metadata
- Download URL: lifelines-0.15.0-py3-none-any.whl
- Upload date:
- Size: 227.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.19.5 CPython/3.6.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a5d0e725f53ce140ef7f691217a04d355aaec85061fdf8984c1c489be397e5de |
|
| MD5 | 4fb018db31afff85a69bb3277000e5d0 |
|
| BLAKE2b-256 | d1f00338cd11b0efbd1d031de89e2c2f071e1c9679ea793c0aace2e8bd932fe8 |
File details
Details for the file lifelines-0.15.0-py2.py3-none-any.whl.
File metadata
- Download URL: lifelines-0.15.0-py2.py3-none-any.whl
- Upload date:
- Size: 227.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.19.5 CPython/3.6.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1f79eafde1aaee781bd1070ab4101d791bf616e09f91cfe3a763c199b5f9c06e |
|
| MD5 | 5c02bdd51a23f2eab95234e783de1ee2 |
|
| BLAKE2b-256 | e2ed05e44362c3320215f02aae3a1c5879d40500295f82693b724275dbebb668 |
