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.4.tar.gz (42.1 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.4-py3-none-any.whl (44.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pytmle-0.2.4.tar.gz
  • Upload date:
  • Size: 42.1 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.4.tar.gz
Algorithm Hash digest
SHA256 0c167842e2cd6fcc8670f7571082f239525ea1e5214cc3ef621631766fbddf6b
MD5 a307d2e6aba175e10c99a3c97327e47e
BLAKE2b-256 746ed0207aad9ad8b106c9cccbc5325cea41c5477e7b91bdf2e46380be927e21

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytmle-0.2.4.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.4-py3-none-any.whl.

File metadata

  • Download URL: pytmle-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 44.0 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2d591b7116a3d4e00a8afec543f64ab8932a2f3a9ad07e8eed2b1512d928353d
MD5 064c22017bdca1bc80a82e5a4d6450da
BLAKE2b-256 e6dd30cbc66c7abc93dff83ed03a49f27d0cfd742a5ddffa5fdd0b8f86bb65c9

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytmle-0.2.4-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