Skip to content

Review tutorials early#230

Open
joshwlambert wants to merge 16 commits into
mainfrom
SOAR-review
Open

Review tutorials early#230
joshwlambert wants to merge 16 commits into
mainfrom
SOAR-review

Conversation

@joshwlambert
Copy link
Copy Markdown
Member

This PR makes several edits to the Clean case data (episodes/clean-data.Rmd), Validate case data (episodes/validate.Rmd) and Aggregate and visualize (episodes/describe-cases.Rmd) episodes.

This PR is part of the review of Epiverse tutorials for the upcoming Outbreak Analytics and Applied Modelling in R short course (Week 1).

Please feel free to revert any changes in this PR that you disagree with.

  • Please check if the PR fulfills these requirements
  • I have read the CONTRIBUTING guidelines
  • I created a new feature branch
  • I have opened and refer to an issue or I am referring to an existing issue
  • Lesson builds locally
  • Checks have been run on GitHub and pass
  • No output errors in the Rendered Changes link generated by github-actions
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Edits to the 3 tutorials included in Week 1 of the Outbreak Analytics and Applied Modelling in R short course. Changes include some fixes to spelling and grammar, improved consistency and clarity. There were a few bug fixes/typos in the code chunks.

  • What is the issue you are addressing?

  • If contributing new additional material please explain why you think it is needed

Any new text in the 3 tutorials reviewed is aimed at improving the clarity of the content being read by the learners.

  • Other information:

@joshwlambert joshwlambert added the upcoming-training To prioritize label Apr 20, 2026
@joshwlambert joshwlambert requested a review from avallecam April 20, 2026 13:45
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 20, 2026

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-230

The following changes were observed in the rendered markdown documents:

 clean-data.md                                      | 122 ++++++++++-----------
 describe-cases.md                                  |  89 +++++++--------
 fig/describe-cases-rendered-unnamed-chunk-10-1.png | Bin 6445 -> 6533 bytes
 fig/describe-cases-rendered-unnamed-chunk-7-1.png  | Bin 6578 -> 6581 bytes
 fig/describe-cases-rendered-unnamed-chunk-8-1.png  | Bin 8983 -> 9036 bytes
 md5sum.txt                                         |  40 +++----
 read-cases.md                                      |  57 ++++++----
 validate.md                                        | 110 +++++++++----------
 8 files changed, 214 insertions(+), 204 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 2026-04-20 13:51:51 +0000

github-actions Bot pushed a commit that referenced this pull request Apr 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

upcoming-training To prioritize

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant