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 reference paper for the reproduction number calculation #151

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

avallecam
Copy link
Member

@avallecam avallecam commented Jul 2, 2024

  • Please check if the PR fulfills these requirements
  • I have read the CONTRIBUTING guidelines
  • A new item has been added to NEWS.md
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Checks have been run locally and pass
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Fix #139

  • What is the current behavior? (You can also link to an open issue here)

README paragraph Quick start section relates contact distribution and probability of infection for the Ro calculation. We can add a reference to this relationship.

  • What is the new behavior (if this is a feature change)?

This proposes to add complementary text to the README to refer to the equation relating contact_distribution, prob_infection and infectious_period elements to calculate Ro, using as reference a paper cited in {epidemics} https://www.nature.com/articles/s41592-020-0822-z

  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

No

  • Other information:

This still requires adding the reference to the paper: https://www.nature.com/articles/s41592-020-0822-z to make @bjornstad2020a work. This can reuse content in https://github.com/epiverse-trace/epidemics/

I wanted to include the infectious_period object to the Warning: ... paragraph, but not sure how to phrase it or if it would be appropriate given the emphasis on contact_distribution and prob_infection. So open for your assessment.

@avallecam
Copy link
Member Author

avallecam commented Jul 2, 2024

@joshwlambert few points

This still requires adding the reference to the paper: https://www.nature.com/articles/s41592-020-0822-z to make @bjornstad2020a work. This can reuse content in https://github.com/epiverse-trace/epidemics/

would you be able to do this? Willing to see how you are storing references.

I wanted to include the infectious_period object to the Warning: ... paragraph, but not sure how to phrase it or if it would be appropriate given the emphasis on contact_distribution and prob_infection. So open for your assessment.

I am open to discussing this further. I am able to add a line that suits the best if appropriate.

@joshwlambert
Copy link
Member

@avallecam I'm happy to add the reference to the bibliography.

Please feel free to add information to the "Warning..." paragraph if you think it will be informative for users. It's worth adding it as we can always revert to the current commit if we decide not to include it.

I'll let you add the text to the README first and then I'll add the reference.

@avallecam
Copy link
Member Author

hi @joshwlambert, welcome back, and thank you for your patience! I just finished the paragraph content.

This is ready for your review and to add the reference paper for @bjornstad2020 https://www.nature.com/articles/s41592-020-0822-z

Copy link
Member

@joshwlambert joshwlambert left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution @avallecam. It's always good to reference epi literature/theory in the packages.

However, in looking through this again I'm not uncertain about whether the descriptions of Bjornstad et al. directly correspond to the individual-based simulation used in {simulist} (see in-text comments).

@jamesmbaazam given your experience with epidemic modelling and branching processes, would you mind taking a look at this PR and letting us know whether the descriptions added to the README and the code are correct?

@@ -94,9 +94,9 @@ onset_to_death <- epiparameter::epidist_db(
)
```

To simulate a line list for COVID-19 with an Poisson contact distribution with a mean number of contacts of 2 and a probability of infection per contact of 0.5, we use the `sim_linelist()` function. The mean number of contacts and probability of infection determine the outbreak reproduction number, if the resulting reproduction number is around one it means we will likely get a reasonably sized outbreak (10 - 1,000 cases, varying due to the stochastic simulation).
To simulate a line list for COVID-19 with a Poisson contact distribution with a mean number of contacts of 2 per day and a probability of infection per contact of 0.5, we use the `sim_linelist()` function. As outlined in @bjornstad2020a, the contact rate ($k$) and probability of infection on contact ($\pi$) are combined into a transmission rate that, multiplied by the infectious period ($1/\gamma$), determines the outbreak reproduction number ($R_o$). If the resulting reproduction number is around one it means we will likely get a reasonably sized outbreak (10 - 1,000 cases, varying due to the stochastic simulation).
Copy link
Member

Choose a reason for hiding this comment

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

I think the addition of "per day" is incorrect, the contact distribution is independent of time, and only defines the number of contacts per case. It is the infectious period that defines the temporal aspect of transmission.

Copy link
Member

Choose a reason for hiding this comment

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

As outlined in @bjornstad2020a, the contact rate ($k$)

I'm now wondering if in fact the sim_linelist() model is not parameterised slightly differently from the description given here and in Bjornstad et al. Related to the above comment, the contact_distribution is not a rate and therefore I'm don't think it is equivalent to $k$.

Copy link
Member

Choose a reason for hiding this comment

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

Perhaps the fact that $k$ is an average and the infectious_period is uniformly sampled in {simulist} mean that both processes give the same result (making an assumption about large sample sizes).

@jamesmbaazam
Copy link
Member

Thanks for tagging. I'll take a closer look tomorrow.

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.

about the relationship between contact distribution, probability of infection, and basic reproduction number
4 participants