Skip to main content

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


Project details


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 hashes)

Uploaded Source

Built Distributions

lifelines-0.15.0-py3-none-any.whl (227.4 kB view hashes)

Uploaded Python 3

lifelines-0.15.0-py2.py3-none-any.whl (227.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page