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

adapt website to overview format linking to all tutorial URLs #137

Merged
merged 23 commits into from
Oct 30, 2024

Conversation

avallecam
Copy link
Member

@avallecam avallecam commented Mar 1, 2024

REMINDER: this is a Partial review. Before merging, redirect this to main


Fix #132
Fix #69

Please check if the PR fulfills these requirements

  • I have read the CONTRIBUTING guidelines

What kind of change does this PR introduce?

  • Update summary page on the "Workshop overview" linking all tutorials.
  • Simplify software setup instructions.
  • Add an introduction episode to the Outbreak Analytics Pipeline on the vision, strategy, and plan for the workshop

What is the current behavior? (You can also link to an open issue here)

The website contains all the episodes before the repo split.

What is the new behavior (if this is a feature change)?

  • Summary page on the Workshop overview
  • Software Setup section with all the packages for all the three tutorial pages
  • Introductory episode on the Outbreak analytics pipeline

Further details

How to review?

@avallecam
Copy link
Member Author

@CarmenTamayo could we have your review for the introduction episode and the updated outlook of the website when building this locally?

github-actions bot pushed a commit that referenced this pull request Mar 1, 2024
Copy link

github-actions bot commented Mar 1, 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/compare/md-outputs..md-outputs-PR-137

The following changes were observed in the rendered markdown documents:

 compare-interventions.md (gone)                    |  258 ---
 config.yaml (gone)                                 |   87 -
 create-forecast.md (gone)                          |  391 ----
 ...rventions-rendered-unnamed-chunk-1-1.png (gone) |  Bin 65010 -> 0 bytes
 ...forecast-rendered-unnamed-chunk-11-1.png (gone) |  Bin 8647 -> 0 bytes
 ...-forecast-rendered-unnamed-chunk-3-1.png (gone) |  Bin 50344 -> 0 bytes
 ...-forecast-rendered-unnamed-chunk-9-1.png (gone) |  Bin 10331 -> 0 bytes
 fig/distribution-zoo.png (new)                     |  Bin 0 -> 23148 bytes
 fig/generation-time-gr2_lrg.jpg (new)              |  Bin 0 -> 354591 bytes
 ...roduction-rendered-unnamed-chunk-5-1.png (gone) |  Bin 50909 -> 0 bytes
 fig/model-choices-rendered-diagram-1.png (gone)    |  Bin 18643 -> 0 bytes
 ...l-choices-rendered-unnamed-chunk-1-1.png (gone) |  Bin 27875 -> 0 bytes
 ...l-choices-rendered-unnamed-chunk-3-1.png (gone) |  Bin 13663 -> 0 bytes
 ...l-choices-rendered-unnamed-chunk-4-1.png (gone) |  Bin 9082 -> 0 bytes
 ...ng-interventions-rendered-baseline-1.png (gone) |  Bin 33760 -> 0 bytes
 ...terventions-rendered-diagram_SEIRV-1.png (gone) |  Bin 23029 -> 0 bytes
 ...-interventions-rendered-plot_masks-1.png (gone) |  Bin 34141 -> 0 bytes
 ...erventions-rendered-plot_vaccinate-1.png (gone) |  Bin 39125 -> 0 bytes
 fig/pkgs-hexlogos-2.png (new)                      |  Bin 0 -> 622072 bytes
 ...sibility-rendered-unnamed-chunk-15-1.png (gone) |  Bin 31186 -> 0 bytes
 ...sibility-rendered-unnamed-chunk-16-1.png (gone) |  Bin 30121 -> 0 bytes
 ...sibility-rendered-unnamed-chunk-19-1.png (gone) |  Bin 84682 -> 0 bytes
 ...ssibility-rendered-unnamed-chunk-4-1.png (gone) |  Bin 5925 -> 0 bytes
 ...ssibility-rendered-unnamed-chunk-7-1.png (gone) |  Bin 10256 -> 0 bytes
 ...d-delays-rendered-unnamed-chunk-20-1.png (gone) |  Bin 11595 -> 0 bytes
 ...ting-transmission-rendered-diagram-1.png (gone) |  Bin 18643 -> 0 bytes
 ...ulating-transmission-rendered-plot-1.png (gone) |  Bin 16307 -> 0 bytes
 ...ulating-transmission-rendered-traj-1.png (gone) |  Bin 51739 -> 0 bytes
 ...ng-transmission-rendered-visualise-1.png (gone) |  Bin 51739 -> 0 bytes
 index.md                                           |   36 +-
 introduction.md                                    |   91 +-
 md5sum.txt                                         |   29 +-
 model-choices.md (gone)                            |  354 ---
 modelling-interventions.md (gone)                  |  430 ----
 quantify-transmissibility.md (gone)                |  539 -----
 read-delays.md (gone)                              | 1675 --------------
 reference.md                                       |   13 +-
 renv.lock (gone)                                   | 2279 --------------------
 setup.md                                           |  302 ++-
 simulating-transmission.md (gone)                  |  464 ----
 40 files changed, 368 insertions(+), 6580 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-10-29 18:57:51 +0000

@avallecam avallecam changed the base branch from version-reference to main October 29, 2024 18:26
github-actions bot pushed a commit that referenced this pull request Oct 29, 2024
@avallecam avallecam merged commit 8634463 into main Oct 30, 2024
4 checks passed
@avallecam avallecam deleted the adapt-overview branch October 30, 2024 09:50
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.

adapt this repo to be the workshop overview site create a site to show the curricula
1 participant