epiverse-trace / epidemics

A library of published compartmental epidemic models, and classes to represent demographic structure, non-pharmaceutical interventions, and vaccination regimes, to compose epidemic scenarios.
https://epiverse-trace.github.io/epidemics/
Other
8 stars 2 forks source link

Enhance `epidemic_size()` #190

Closed pratikunterwegs closed 3 months ago

pratikunterwegs commented 5 months ago

This issue stems from comments by @jamesmbaazam on #176 (below), and requests enhancements to epidemic_size().

  • Could you return the "stage" as part of the output? I can easily imagine that being useful in cases where a user wants to plot the epidemic size at various stages of the outbreak.
  • I would suggest renaming "stage" to timepoint or something similar and filter by time instead of stage. We often think of epidemic timelines in terms of dates and not stages. Using stages forces you to think in terms of percentages of the whole timeline. Additionally, you could make "stage" an optional argument alongside the new "time" argument.