Skip to main content

No project description provided

Project description

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

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

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

Source Distribution

epyestim-0.1.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

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

epyestim-0.1-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file epyestim-0.1.tar.gz.

File metadata

  • Download URL: epyestim-0.1.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for epyestim-0.1.tar.gz
Algorithm Hash digest
SHA256 1abaea18907c04440652e5e99da9dd98b641a0df952f32869b903df311bd1d73
MD5 2f9de8dd4a19e8f63566d33d583ed79a
BLAKE2b-256 8c5cb6e95fc91605ac97815218acc6d14153e6338316f858dec7722c9ac75c6e

See more details on using hashes here.

File details

Details for the file epyestim-0.1-py3-none-any.whl.

File metadata

  • Download URL: epyestim-0.1-py3-none-any.whl
  • Upload date:
  • Size: 10.7 kB
  • Tags: Python 3
  • Uploaded using 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

File hashes

Hashes for epyestim-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2a8a62af097eb5744cd934d2381b117af07d8e9ccccbdc4b2adca7f4f90ffa41
MD5 ccec37e41144481be88252045f9cd243
BLAKE2b-256 3eb569e201b9d925388d1426992da78e41064805645a97099a62f5ef458c436b

See more details on using hashes here.

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