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

Camp population changes for diphtheria model #158

Merged
merged 18 commits into from
Feb 5, 2024

Conversation

pratikunterwegs
Copy link
Collaborator

@pratikunterwegs pratikunterwegs commented Jan 25, 2024

This PR:

  1. Fixes Allow changes in population sizes #154 for the diphtheria model by adding the population_change mechanic, which is passed as a named list of times and values of changes to each demographic group at those times. This functionality could be expanded to other models in future if needed.
  • Adds the population_changes C++ struct in the population namespace, with a member function to check for any current changes; also updates relevant header and source files for the diphtheria model;
  • Adds checks to the diphtheria model arguments checker to handle the case of no population changes (the default);
  • Updates the documentation for the diphtheria model;
  • Adds tests for the population change functionality; NOTE: this functionality WILL NOT SATISFY expectations of constant model population sizes.
  1. Fixes Add a vignette for the diphtheria model #157 by adding a basic vignette showing the population change functionality.

@pratikunterwegs pratikunterwegs self-assigned this Jan 25, 2024
@pratikunterwegs pratikunterwegs marked this pull request as ready for review January 26, 2024 14:43
Copy link
Member

@adamkucharski adamkucharski left a comment

Choose a reason for hiding this comment

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

Nice to see this included. I've made a few edits to the vignette for clarity.

Also wondered: is the current lack of vaccination a technical obstacle in the model (i.e. not possible with current modular structure)? Or just omitted for simplicity?

Finally, I get a lot of non-essential CPP warnings when installing the package from branch. Do we suppress these for users in end package (as probably won't add much value for majority of users, and may make them wonder if something is wrong)?

vignettes/diphtheria.Rmd Outdated Show resolved Hide resolved
vignettes/diphtheria.Rmd Outdated Show resolved Hide resolved
vignettes/diphtheria.Rmd Outdated Show resolved Hide resolved
vignettes/diphtheria.Rmd Outdated Show resolved Hide resolved
vignettes/diphtheria.Rmd Outdated Show resolved Hide resolved
vignettes/diphtheria.Rmd Outdated Show resolved Hide resolved
vignettes/diphtheria.Rmd Outdated Show resolved Hide resolved
vignettes/diphtheria.Rmd Outdated Show resolved Hide resolved
vignettes/diphtheria.Rmd Outdated Show resolved Hide resolved
vignettes/diphtheria.Rmd Outdated Show resolved Hide resolved
@pratikunterwegs
Copy link
Collaborator Author

Thanks for taking a look @adamkucharski - will accept your edits and merge shortly.

Also wondered: is the current lack of vaccination a technical obstacle in the model (i.e. not possible with current modular structure)? Or just omitted for simplicity?

For simplicity really, following the scenario described in the paper. It's definitely possible to add a vaccination compartment if necessary. We did hear at MSF Manson that they might be interested in modelling for vaccination advocacy in camps, so happy to work along those lines if you have any input.

Finally, I get a lot of non-essential CPP warnings when installing the package from branch. Do we suppress these for users in end package (as probably won't add much value for majority of users, and may make them wonder if something is wrong)?

We do not, admittedly, as the suppress warnings flag -w is apparently non-portable and throws up an R CMD check warning. Hopefully if users install from R-universe (and later, CRAN) they'll get a pre-compiled binary which won't have these.

@pratikunterwegs pratikunterwegs merged commit f7e33b5 into main Feb 5, 2024
10 checks passed
@pratikunterwegs pratikunterwegs deleted the feature/pop-change branch February 5, 2024 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a vignette for the diphtheria model Allow changes in population sizes
2 participants