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

Improve documentation for those passing in a GI #793

Closed
kaitejohnson opened this issue Sep 26, 2024 · 1 comment · Fixed by #799
Closed

Improve documentation for those passing in a GI #793

kaitejohnson opened this issue Sep 26, 2024 · 1 comment · Fixed by #799

Comments

@kaitejohnson
Copy link
Contributor

Type of issue:
Commenting on existing documentation/ language in vignettes

Detail:
While the model definition makes it clear that the implementation of the renewal approach expects time indexing starting at day 1, those not reading the model definition carefully may miss this. I think it would be nice to flag to the user that if they pass in a vector to the GI, its assumed to be 1 indexed not 0 indexed (so the first value reflects the probability of transmission on day 1 of infection not day 0, the day they were infected).

Could add to:

  • the main EpiNow2 vignette (would need to add an example where GI is being set by the user)
  • the documentation for generation_time or generation_time_opts

@seabbs
Copy link
Contributor

seabbs commented Sep 30, 2024

Thanks @kaitejohnson this is a good point. We might also want to add some discussion of the user choice to either left truncate or to shift the distribution when passed as a vector

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 a pull request may close this issue.

2 participants