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 measles outbreak example #51

Merged
merged 65 commits into from
Nov 20, 2024
Merged

add measles outbreak example #51

merged 65 commits into from
Nov 20, 2024

Conversation

Degoot-AM
Copy link
Contributor

@Degoot-AM Degoot-AM commented Oct 10, 2024

This PR

  1. Adds an introduction to mathematical epidemiology using measles outbreak in Burkina Faso using {epidemics}.
  2. use r_eff from {finalsize} as a quick first pass to estimate transmission potential from vaccine coverage.
  3. This document goes under more tab as an additional information for learners.

Copy link

github-actions bot commented Oct 10, 2024

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/epiverse-trace/tutorials-late/compare/md-outputs..md-outputs-PR-51

The following changes were observed in the rendered markdown documents:

 BF_measles.md (new)                                | 940 +++++++++++++++++++++
 compare-interventions.md                           |   4 +-
 ...F_measles-rendered-unnamed-chunk-10-1.png (new) | Bin 0 -> 67684 bytes
 ...F_measles-rendered-unnamed-chunk-11-1.png (new) | Bin 0 -> 50927 bytes
 ...BF_measles-rendered-unnamed-chunk-2-1.png (new) | Bin 0 -> 28872 bytes
 ...BF_measles-rendered-unnamed-chunk-6-1.png (new) | Bin 0 -> 64815 bytes
 ...BF_measles-rendered-unnamed-chunk-9-1.png (new) | Bin 0 -> 56781 bytes
 fig/model-choices-rendered-unnamed-chunk-3-1.png   | Bin 19296 -> 14612 bytes
 fig/model-choices-rendered-unnamed-chunk-4-1.png   | Bin 9209 -> 9209 bytes
 fig/t0.drawio.png (new)                            | Bin 0 -> 27089 bytes
 fig/t1.drawio.png (new)                            | Bin 0 -> 25467 bytes
 fig/t2.drawio.png (new)                            | Bin 0 -> 29583 bytes
 fig/t3.drawio.png (new)                            | Bin 0 -> 29649 bytes
 md5sum.txt                                         |  29 +-
 14 files changed, 957 insertions(+), 16 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-11-20 20:38:34 +0000

@Degoot-AM Degoot-AM requested a review from avallecam October 11, 2024 14:43
@avallecam
Copy link
Member

thanks for contributing! I am doing some local edits to make this contribution a Rmd rendered file

@avallecam
Copy link
Member

I finished with the edits required to clean this PR. Now we have an Rmd file with four figures. Next week I'll provide my feedback matching this case study and the way we can use it in the training.

@avallecam avallecam marked this pull request as draft October 25, 2024 15:28
Copy link
Member

@avallecam avallecam left a comment

Choose a reason for hiding this comment

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

thanks @Degoot-AM for adding this content! I liked the approach of dosifying the content by doing first a well-mixed population model to introduce the rates, population, and initial conditions, and leave to a second stage the addition of the contact matrix.

There are two major request to change that I added as line edit suggestions are:

  • change "rate" to "contact" for the usage of a <contacts_intervention> class, and add a reduction rate per age strata
  • fix the "nu" parameter to vaccination rate, instead of vaccine efficacy, which is not how this argument is defined in the function.

Copy link
Member

@avallecam avallecam left a comment

Choose a reason for hiding this comment

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

one additional minor edit to keep homogeneity across materials. we are using alpha instead of omega

Degoot-AM and others added 6 commits November 20, 2024 20:01
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
github-actions bot pushed a commit that referenced this pull request Nov 20, 2024
Degoot-AM and others added 5 commits November 20, 2024 20:10
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
github-actions bot pushed a commit that referenced this pull request Nov 20, 2024
Degoot-AM and others added 6 commits November 20, 2024 20:32
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
github-actions bot pushed a commit that referenced this pull request Nov 20, 2024
@Degoot-AM Degoot-AM merged commit eb29b8f into main Nov 20, 2024
4 checks passed
@Degoot-AM Degoot-AM deleted the add_case_study branch November 20, 2024 20:50
github-actions bot pushed a commit that referenced this pull request Nov 20, 2024
Auto-generated via `{sandpaper}`
Source  : eb29b8f
Branch  : main
Author  : Abdoelnaser M Degoot <degoot@aims.ac.za>
Time    : 2024-11-20 20:50:03 +0000
Message : add measles outbreak example (#51)

* add measles outbreak example

* add effective  R_0

* add HIT explanation for r_eff

* add hit

* rename file from md to Rmd format

* remove quarto features to make Rmd to knit R code

* replace bib tags with hyperlinks + remove bib file

* clean middle dot spaces between words

* delete associated quarto files

* fix heading typos

* fix mathbfcal rendering issue

* clean package loading + add namespace

* remove output chunk figures

* remove extra quarto tags

* fix local lintr checks

* change  incubation to latent

* replacing \cdot with .

* reducing math technicals

* Fixing typos of SIER vs SEIR

* clarifying distinction between incubation period and latent period.

* remove normalization

* assumptions vs biological facts.

* updating fig1 caption

* HIT vs R_eff

* fixing a typo:  compagain

* add MMR's efficacy ref

* replace `take off` witn `start spreading`

* add measles R0 range ref.

* intuition behind beta/gamma

* relation between R0 and generation time.

* more on final size

* add logic behind HIT equation

* add refer

* gamma

* some words to clarify this assumption

* using vs uaing

* more on R_eff

* remove loading finalsize since it only used by namespace ::.

* add issue #59

* add clarification

* removing typo

* remove shading

* removed duplicated statement.

* excluding vaccinated when using new_infections.

* obs vs R0

* some checks

* fixing typos

* typos

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

---------

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
github-actions bot pushed a commit that referenced this pull request Nov 20, 2024
Auto-generated via `{sandpaper}`
Source  : 5aca77b
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-11-20 20:56:03 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : eb29b8f
Branch  : main
Author  : Abdoelnaser M Degoot <degoot@aims.ac.za>
Time    : 2024-11-20 20:50:03 +0000
Message : add measles outbreak example (#51)

* add measles outbreak example

* add effective  R_0

* add HIT explanation for r_eff

* add hit

* rename file from md to Rmd format

* remove quarto features to make Rmd to knit R code

* replace bib tags with hyperlinks + remove bib file

* clean middle dot spaces between words

* delete associated quarto files

* fix heading typos

* fix mathbfcal rendering issue

* clean package loading + add namespace

* remove output chunk figures

* remove extra quarto tags

* fix local lintr checks

* change  incubation to latent

* replacing \cdot with .

* reducing math technicals

* Fixing typos of SIER vs SEIR

* clarifying distinction between incubation period and latent period.

* remove normalization

* assumptions vs biological facts.

* updating fig1 caption

* HIT vs R_eff

* fixing a typo:  compagain

* add MMR's efficacy ref

* replace `take off` witn `start spreading`

* add measles R0 range ref.

* intuition behind beta/gamma

* relation between R0 and generation time.

* more on final size

* add logic behind HIT equation

* add refer

* gamma

* some words to clarify this assumption

* using vs uaing

* more on R_eff

* remove loading finalsize since it only used by namespace ::.

* add issue #59

* add clarification

* removing typo

* remove shading

* removed duplicated statement.

* excluding vaccinated when using new_infections.

* obs vs R0

* some checks

* fixing typos

* typos

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

* Update learners/BF_measles.Rmd

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>

---------

Co-authored-by: Andree Valle Campos <avallecam@gmail.com>
avallecam added a commit that referenced this pull request Nov 21, 2024
avallecam added a commit that referenced this pull request Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants