Skip to main content

epyestim

Introduction

epyestim estimates the effective reproduction number from time series of reported case numbers of epidemics. It is a Python reimplementation of the method outlined by Huisman et al. [1], making use of the method by Cori et al. [2] to estimate the reproduction number R from infection data, available in the R package EpiEstim [3].

The main steps for estimation of the effective reproduction number are:

  • Bootstrapping the series of reported case numbers
  • Smoothing using a LOWESS filter
  • MLE of the infection incidence time series using an adaptation of the Richardson-Lucy deconvolution algorithm.
  • Bayesian estimation of the effective reproduction number using the method of Cori et al. [2]

Aggregate estimates for the reproduction number are obtained by bootstrap aggregation (bagging).

The user can choose to output either time-varying estimates or piecewise constant estimates on fixed arbitrary time intervals.

How to install epyestim

pip install epyestim

How to use epyestim

Basic usage of the epyestim package applied to COVID-19 data is explained in the Jupyter tutorial notebook.

The core functions relevant for users are:

  • epyestim.bagging_r for the complete estimation process outlined above
  • epyestim.covid19.r_covid for the same function with default parameters for COVID-19
  • epyestim.estimate_r.estimate_r for the R estimation from infection numbers, based on the EpiEstim package

Authors

How to contribute

Error reports and suggestions for improvements via GitHub issues are very welcome.

References

[1] Jana S. Huisman, Jeremie Scire, Daniel Angst, Richard Neher, Sebastian Bonhoeffer, Tanja Stadler: A method to monitor the effective reproductive number of SARS-CoV-2 https://ibz-shiny.ethz.ch/covid-19-re/methods.pdf

[2] Anne Cori, Neil M. Ferguson, Christophe Fraser, Simon Cauchemez: A New Framework and Software to Estimate Time-Varying Reproduction Numbers During Epidemics, American Journal of Epidemiology, Volume 178, Issue 9, 1 November 2013, Pages 1505–1512, https://doi.org/10.1093/aje/kwt133

[3] EpiEstim CRAN package: https://cran.r-project.org/web/packages/EpiEstim/index.html

Metadata

Release files for epyestim 0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for epyestim 0.1
File Size Uploaded Provenance
epyestim-0.1.tar.gz 9.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for epyestim 0.1
File Interpreter ABI Platform
epyestim-0.1-py3-none-any.whl Python 3 none any Details

Total release size: 19.8 kB

Release files / epyestim-0.1.tar.gz

Download URL epyestim-0.1.tar.gz
Size 9.1 kB
Tags Source
SHA-256 checksum
How to use checksums
1abaea18907c04440652e5e99da9dd98b641a0df952f32869b903df311bd1d73
BLAKE2b-256 checksum
How to use checksums
8c5cb6e95fc91605ac97815218acc6d14153e6338316f858dec7722c9ac75c6e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.1.post20201107 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.5

Release files / epyestim-0.1-py3-none-any.whl

Download URL epyestim-0.1-py3-none-any.whl
Size 10.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2a8a62af097eb5744cd934d2381b117af07d8e9ccccbdc4b2adca7f4f90ffa41
BLAKE2b-256 checksum
How to use checksums
3eb569e201b9d925388d1426992da78e41064805645a97099a62f5ef458c436b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.1.post20201107 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.5

Security for epyestim 0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page