Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add epidemic risk vignette and probability_contain() #24

Merged
merged 20 commits into from
Jun 13, 2023

Conversation

joshwlambert
Copy link
Member

This PR addresses #12 (and makes a start on #13).

The primary focus of this PR is to add a vignette that discusses the application of {superspreading} functions to decision making and policy. This takes inspiration from the document initially shared in #5 and mentioned in #12 which is a preprint used by SAGE during the COVID-19 pandemic.

As part of this vignette on control measures, a new function was added: probability_contain(). This implements population-level control measures. It does not complete the requirements of #13 which also requires individual level control and may relate to development from epiverse-trace/epichains#3.

Tests and documentation are added for probability_contain(). {bpmodels} is added as a remote dependency, and {ggtext} as a suggested dependency.

@joshwlambert joshwlambert added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 8, 2023
Copy link
Member

@jamesmbaazam jamesmbaazam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a nice vignette to illustrate a use case for the package. I've suggested a few changes that should be straightforward to fix.

vignettes/epidemic_risk.Rmd Outdated Show resolved Hide resolved
R/probability_contain.R Show resolved Hide resolved
vignettes/epidemic_risk.Rmd Outdated Show resolved Hide resolved
vignettes/epidemic_risk.Rmd Show resolved Hide resolved
vignettes/epidemic_risk.Rmd Outdated Show resolved Hide resolved
vignettes/epidemic_risk.Rmd Outdated Show resolved Hide resolved
vignettes/epidemic_risk.Rmd Outdated Show resolved Hide resolved
vignettes/epidemic_risk.Rmd Outdated Show resolved Hide resolved
vignettes/epidemic_risk.Rmd Outdated Show resolved Hide resolved
vignettes/epidemic_risk.Rmd Outdated Show resolved Hide resolved
@jamesmbaazam jamesmbaazam self-assigned this Jun 8, 2023
@joshwlambert
Copy link
Member Author

Thanks for the comments @jamesmbaazam!

@joshwlambert joshwlambert merged commit 7295f2f into main Jun 13, 2023
@joshwlambert joshwlambert deleted the outbreak_risk_vig branch June 13, 2023 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants