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

Shorten generation_time_opts() to gt_opts() as alias #698

Merged
merged 6 commits into from
Jul 2, 2024
Merged

Shorten generation_time_opts() to gt_opts() as alias #698

merged 6 commits into from
Jul 2, 2024

Conversation

jamesmbaazam
Copy link
Contributor

Description

This PR closes #564.

The generation_time_opts() function was deemed too long and tedious to specify so has been shortened to gt_opts(). Calls to both functions are equivalent and they share the same documentation.

Initial submission checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have tested my changes locally (using devtools::test() and devtools::check()).
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required and rebuilt docs if yes (using devtools::document()).
  • I have followed the established coding standards (and checked using lintr::lint_package()).
  • I have added a news item linked to this PR.

After the initial Pull Request

  • I have reviewed Checks for this PR and addressed any issues as far as I am able.

NEWS.md Outdated Show resolved Hide resolved
@jamesmbaazam
Copy link
Contributor Author

CI errors will be fixed when #700 is merged.

@jamesmbaazam
Copy link
Contributor Author

Leaving a note here that touchstone has to checkout main to perform the benchmarks against this branch, but main doesn't have gt_opts() yet, so the touchstone script (https://github.com/epiforecasts/EpiNow2/blob/main/touchstone/script.R) here will have to use the long form generation_time_opts() for now and be updated when this PR is merged.

@jamesmbaazam
Copy link
Contributor Author

CI errors will be fixed when #700 is merged.

This has been resolved but was one of two errors in the CI.

seabbs
seabbs previously approved these changes Jul 1, 2024
Copy link
Contributor

@seabbs seabbs left a comment

Choose a reason for hiding this comment

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

Lgtm

sbfnk
sbfnk previously approved these changes Jul 2, 2024
NEWS.md Outdated Show resolved Hide resolved
R/estimate_infections.R Outdated Show resolved Hide resolved
@sbfnk sbfnk enabled auto-merge (squash) July 2, 2024 13:29
@jamesmbaazam jamesmbaazam dismissed stale reviews from sbfnk and seabbs via a68fb6e July 2, 2024 14:26
sbfnk
sbfnk previously approved these changes Jul 2, 2024
sbfnk
sbfnk previously approved these changes Jul 2, 2024
@sbfnk sbfnk merged commit efeb42a into main Jul 2, 2024
10 checks passed
@sbfnk sbfnk deleted the gt-opts branch July 2, 2024 18:32
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.

create gt_opts as an alias for generation_time_opts
3 participants