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

Replace references to serial interval with generation interval #116

Merged
merged 21 commits into from
Dec 1, 2023

Conversation

jamesmbaazam
Copy link
Member

This PR closes #109 by:

  • Renaming the serials_dist argument to gen_interval
  • Revising previous wordings referring to the serial interval to use "generation interval" instead.

@jamesmbaazam jamesmbaazam added this to the v0.1.0 milestone Nov 29, 2023
@jamesmbaazam jamesmbaazam self-assigned this Nov 29, 2023
@jamesmbaazam jamesmbaazam changed the title Rename function to refer to gen_interval Replace references to serial interval with generation interval Nov 29, 2023
@jamesmbaazam jamesmbaazam requested a review from sbfnk November 30, 2023 14:08
Copy link
Contributor

@sbfnk sbfnk left a comment

Choose a reason for hiding this comment

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

Yes!

I would prefer generation_interval to gen_interval. Do you think it's too much to type?

Or as a compromise we could call it generation_time (only 3 characters more than gen_interval...) which would have the benefit of being the same as in EpiNow2.

@jamesmbaazam
Copy link
Member Author

Or as a compromise we could call it generation_time (only 3 characters more than gen_interval...) which would have the benefit of being the same as in EpiNow2.

I'm a big fun of {EpiNow2}, so I'll go with this. I think there is a similar notion in {epiparameter}, so +1.

Will make the change.

@jamesmbaazam jamesmbaazam force-pushed the serial_interval-to-gen_interval branch from 6e892a5 to 3fe6637 Compare November 30, 2023 23:38
@codecov-commenter
Copy link

codecov-commenter commented Nov 30, 2023

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (6014763) 98.06% compared to head (4467fec) 98.64%.

❗ Current head 4467fec differs from pull request most recent head 8bfb2a3. Consider uploading reports for the commit 8bfb2a3 to get more accurate results

Files Patch % Lines
R/simulate.r 92.85% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #116      +/-   ##
==========================================
+ Coverage   98.06%   98.64%   +0.57%     
==========================================
  Files           8        8              
  Lines         518      518              
==========================================
+ Hits          508      511       +3     
+ Misses         10        7       -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jamesmbaazam jamesmbaazam force-pushed the serial_interval-to-gen_interval branch from cfec50b to 3fe6637 Compare December 1, 2023 11:11
@jamesmbaazam jamesmbaazam force-pushed the serial_interval-to-gen_interval branch from 3fe6637 to bf4a751 Compare December 1, 2023 15:38
@jamesmbaazam jamesmbaazam requested a review from sbfnk December 1, 2023 16:53
vignettes/epichains.Rmd Outdated Show resolved Hide resolved
Copy link
Contributor

@sbfnk sbfnk left a comment

Choose a reason for hiding this comment

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

All looking good - we're now using both generation "time" and "interval". Perhaps that's fine as they're used interchangeably in the literature but I was wondering if it would be worth doing a search/replace "generation interval" -> "generation time" everywhere and clarify in just one point that they're the same (I made a suggestion where).

vignettes/projecting_incidence.Rmd Outdated Show resolved Hide resolved
vignettes/projecting_incidence.Rmd Outdated Show resolved Hide resolved
@jamesmbaazam jamesmbaazam merged commit 30b68a0 into main Dec 1, 2023
8 checks passed
@jamesmbaazam jamesmbaazam deleted the serial_interval-to-gen_interval branch December 1, 2023 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

generation vs. serial interval
4 participants