epiverse-trace / epiparameter

R package with library of epidemiological parameters for infectious diseases and functions and classes for working with parameters
https://epiverse-trace.github.io/epiparameter
Other
33 stars 11 forks source link

Specify probability distribution in `as_epidist()` #335

Closed joshwlambert closed 4 months ago

joshwlambert commented 5 months ago

This PR addresses #310 by extending as_epidist() to accept a prob_dist argument. This is then read by epireview_to_epidist() and can be used to parameterise a distribution if parameters or summary statistics are available but a probability distribution is not specified.

A section has been added to the data_from_epireview.Rmd vignette to outline how this feature works and to warn users against using this feature improperly.

Unit tests have been added to check prob_dist passed via ... in as_epidist() works as expected and Faye et al. (2015) has been added to references.JSON as it is cited in data_from_epireview.Rmd.