-
Notifications
You must be signed in to change notification settings - Fork 1
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
base: main
Are you sure you want to change the base?
Conversation
@joshwlambert few points
would you be able to do this? Willing to see how you are storing references.
I am open to discussing this further. I am able to add a line that suits the best if appropriate. |
@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. |
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 |
There was a problem hiding this 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). |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps the fact that infectious_period
is uniformly sampled in {simulist} mean that both processes give the same result (making an assumption about large sample sizes).
Thanks for tagging. I'll take a closer look tomorrow. |
NEWS.md
Fix #139
README paragraph Quick start section relates contact distribution and probability of infection for the Ro calculation. We can add a reference to this relationship.
This proposes to add complementary text to the README to refer to the equation relating
contact_distribution
,prob_infection
andinfectious_period
elements to calculate Ro, using as reference a paper cited in {epidemics} https://www.nature.com/articles/s41592-020-0822-zNo
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 theWarning: ...
paragraph, but not sure how to phrase it or if it would be appropriate given the emphasis oncontact_distribution
andprob_infection
. So open for your assessment.