Skip to main content

A Flexible Python Implementation of Targeted Estimation for Survival and Competing Risks Analysis

Project description

PyTMLE

PyTMLE is a flexible Python implementation of the Targeted Maximum Likelihood Estimation (TMLE) framework for survival and competing risks outcomes.

The package can be installed from PyPI, for example using pip:

pip install pytmle

It is designed to be easy to use with default models for initial estimates of nuisance functions which are applied in a super learner framework. With a pandas dataframe containing event times, indicators, and (binary) treatment group information in specified columns, it is straight-forward to fit a main PyTMLE class object and get predictions and plots for selected target_times:

from pytmle import PyTMLE

tmle = PyTMLE(df, 
              col_event_times="time", 
              col_event_indicator="status", 
              col_group="group", 
              target_times=target_times)

tmle.plot(type="risks") # get estimated counterfactual CIF, or set to "rr" or "rd" for ATE estimates based on RR or RD
pred = tmle.predict(type="risks") # store estimates in a data frame

However, it also allows for custom models to be used for the initial estimates or even passing initial estimates directly to the second TMLE stage.

Have a look at the package's Read the Docs page for the detailed API reference and tutorial notebooks.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytmle-0.2.3.tar.gz (41.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pytmle-0.2.3-py3-none-any.whl (43.6 kB view details)

Uploaded Python 3

File details

Details for the file pytmle-0.2.3.tar.gz.

File metadata

  • Download URL: pytmle-0.2.3.tar.gz
  • Upload date:
  • Size: 41.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pytmle-0.2.3.tar.gz
Algorithm Hash digest
SHA256 a7797d331525365827b180c8acbf3e91a9451c75024d95a7fe14230ca3c9e7a8
MD5 326006bb96fd0b292ed8e2c7f4505740
BLAKE2b-256 e0493d2293eafe32832713ee2a19373ed61f2495abd970127cbf220d30d96735

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytmle-0.2.3.tar.gz:

Publisher: publish-to-pypi.yml on SCAI-BIO/pytmle

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pytmle-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: pytmle-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 43.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pytmle-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e82144b2f53ef3f440784b2f63b70304cf4e5fa6f5f1202b96bd36d2826e1d60
MD5 556fead45759341a4ee090cde9a8de17
BLAKE2b-256 ba62bb17b3f9ae09c00d4d0a636cc8a8750a0c948f7c410a9b8a663ebef845b5

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytmle-0.2.3-py3-none-any.whl:

Publisher: publish-to-pypi.yml on SCAI-BIO/pytmle

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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