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

Remove {i2extras} #86

Merged
merged 5 commits into from
Jun 24, 2024
Merged

Remove {i2extras} #86

merged 5 commits into from
Jun 24, 2024

Conversation

Degoot-AM
Copy link
Contributor

This PR completely removes the usage of {i2extras} from tutorials, and thus addressing issue #71. It also add section for calculating and visualizing the cumulative cases, and peak estimation.

Copy link

github-actions bot commented Jun 20, 2024

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/epiverse-trace/tutorials-early/compare/md-outputs..md-outputs-PR-86

The following changes were observed in the rendered markdown documents:

 config.yaml                                        |   2 +-
 describe-cases.md                                  |  55 ++++-
 fig/describe-cases-rendered-unnamed-chunk-7-1.png  | Bin 9500 -> 9477 bytes
 ...ribe-cases-rendered-unnamed-chunk-8-1.png (new) | Bin 0 -> 6284 bytes
 ...-analysis-rendered-unnamed-chunk-1-1.png (gone) | Bin 21079 -> 0 bytes
 ...-analysis-rendered-unnamed-chunk-2-1.png (gone) | Bin 20476 -> 0 bytes
 ...-analysis-rendered-unnamed-chunk-5-1.png (gone) | Bin 22930 -> 0 bytes
 ...-analysis-rendered-unnamed-chunk-6-1.png (gone) | Bin 20947 -> 0 bytes
 md5sum.txt                                         |   5 +-
 simple-analysis.md (gone)                          | 229 ---------------------
 10 files changed, 55 insertions(+), 236 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-06-24 11:18:56 +0000

@Degoot-AM Degoot-AM requested a review from avallecam June 20, 2024 19:09
github-actions bot pushed a commit that referenced this pull request Jun 20, 2024
@avallecam
Copy link
Member

thanks! I'll start the review today

Copy link
Member

@avallecam avallecam 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 this update! Brief edit suggestions and typos to incorporate. Some additional comments are below:

I think we can later use the simple-analysis.Rmd file to still showcase the log-linear model more explicitly with all the assumptions and limitations before introducing EpiNow2. Assumptions and limitations and deciding why to choose a model are easier to interiorize than methods and possibly a more useful message. Filled as issue #87

Also, I would suggest that for the following PRs, try not to commit the renv.lock file. First, check if the GH workflow check passes or not. We should prefer to update renv files in isolated PRs only unless checks do not pass due to package versions. For this it seems not to break anything, so let's keep it.

episodes/describe-cases.Rmd Outdated Show resolved Hide resolved
episodes/describe-cases.Rmd Outdated Show resolved Hide resolved
## Peak estimation

One can estimate the peak --the time with highest number of recorded cases-- using `estimate_peak()` function from the {incidence2} package.
This function employs a bootstrapping method to determine the peak time.
Copy link
Member

Choose a reason for hiding this comment

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

in further versions, we can add a callout explanation or simulation to understand the bootstrapping method.

episodes/describe-cases.Rmd Outdated Show resolved Hide resolved
Copy link
Member

@avallecam avallecam left a comment

Choose a reason for hiding this comment

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

ready to merge 🚀

github-actions bot pushed a commit that referenced this pull request Jun 24, 2024
@avallecam avallecam merged commit 5818e17 into main Jun 24, 2024
4 checks passed
@avallecam avallecam deleted the remove-i2extras branch June 24, 2024 11:20
@Degoot-AM Degoot-AM mentioned this pull request Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants