-
Notifications
You must be signed in to change notification settings - Fork 4
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
Late task tutorials #34
Conversation
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:
Rendered Changes🔍 Inspect the changes: https://github.com/epiverse-trace/tutorials/compare/md-outputs..md-outputs-PR-34 The following changes were observed in the rendered markdown documents:
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 2023-10-31 11:44:39 +0000 |
Thanks @amanda-minter - I've just merged #31 into |
Added text and code to initial conditions section and updated initial plot to have same initial conditions
Added content to generating trajectories, which details specifying the initial conditions, demography vector and running the model
Content edits and reordering of some text
Updated name to simulating_transmission to better reflect tutorial content
Citations have been changed to hyperlinks, so references no longer needed in Rmd header
Added tutorial content on all sections for Choosing a model
Add 'Coming soon' to incomplete sections
Added section on how to account for uncertainty in R0 for influenza example
Updated code to run multiple model simulations to be the same as vignette and replaced {data.table} functions with `stat_summary()` stay within Tidyverse
Hi @avallecam - just looking at this I see that you're merging |
Thank you for letting me know. I think I misunderstood your suggestion 1 from here #33 (comment) So the specific suggestion is to stop doing this "merge branch main into dev branch" in order to keep linear histories and facilitate the "rebase and merge" option. I interpreted this way because of a button suggesting this step at the end of the PR (in the section of changes requested and checks passed). |
Yes, that's right. Yes, the button is unfortunately set to have the "wrong" option as the default, so you would need to select the rebase option manually. |
Thanks Pratik for your thorough review. I think I have addressed the majority of your comments, a couple that are not referenced are: GeneralThe tutorials are aimed at specific learner profiles, this will be added (#6) and discussed in the introductory materials (this is one of the later tutorials in the workflow). General technical
Do you have any further comments on the changes I have made in response to your review? |
Thanks @amanda-minter, looks alright to me, but would be worth running it by Roz or others to sign off on it |
Great. I had a look during the development day and looks good for merging. |
To confirm, I will need to squash and merge this PR as |
Yes that's right. I don't think you'll be able to rebase and merge as there are merge commits in this branch. |
Auto-generated via {sandpaper} Source : 969a11b Branch : main Author : Amanda Minter <[email protected]> Time : 2023-10-31 15:37:33 +0000 Message : Late task tutorials (#34) * Created late task 1 episode file * Draft questions. objectives and section titles * Added notes on lesson content and provisional model equations * More lesson content to Model structures section * Outlines of remaining sections added * Edits to model structure section * Minor updates to model structures * Edits to introduction section * Add content to and reorder model parameters section * Added example plot to introduction * Minor edit to text * Add initial conditions section Added text and code to initial conditions section and updated initial plot to have same initial conditions * Reorder of sections * Updated text to introduction * Add generating trajectories section Added content to generating trajectories, which details specifying the initial conditions, demography vector and running the model * Added contact matrix section * Edits to tutorial content Content edits and reordering of some text * Changed naming of tutorial Updated name to simulating_transmission to better reflect tutorial content * Remove references from Rmd Citations have been changed to hyperlinks, so references no longer needed in Rmd header * Add file for `model_choices.Rmd` * Additions and edits to tutorial objectives * Update model_choices.Rmd Added tutorial content on all sections for Choosing a model * Update model_choices.Rmd Add 'Coming soon' to incomplete sections * Add uncertainty section Added section on how to account for uncertainty in R0 for influenza example * Fix typo * Add Comparing interventions tutorial * Remove default lesson * Update model_choices.Rmd Updated challenge outline to address #27 and to include Carpentries hint structure * Add glossary and add terms to `simulating_transmission` Glossary added in response to #24, additional transmission types added to `simulating_transmission` tutorial * Hide messages in output Fixes #26 for `simulating_transmission` and `compare_scenarios` * Update package and function notation Fixes #25 for current tutorials * Fix typo * Add function to view model names Fixes #23 * Add callout for exposed, infected, infectious Fixes #20 * Add instructor notes to tutorials Address #17 * Add concept dependencies to tutorials Addresses #19 * Add flow diagram of model equations Fixes #21 * Add definitions of outbreak and epidemic Added to `model_choices` tutorial and relevant definitions added to glossary * Add challenge to `model_choices` tutorial Fixes #14 * Remove reference to epidemic versus outbreak Keep tutorial content on the types of model used for epidemic versus outbreak analysis, but remove exact reference to epidemic and outbreak model types * Update intervention functions * Restructure tutorials Split `compare_interventions` into two tutorials : `modelling_interventions` and `compare_interventions` * Update outline of `compare_interventions` * Fix typo in ODE equations * Add section on mask wearing and vaccination Updates to school closure section as well as added sections on mask wearing and vaccination * typo and minor rephrase * Add updated ebola model definition * Update filenames Updating filenames to be consistent with the default naming of episodes from `create_episode` * Add to glossary terms Incubation period and latent period * Updates to parameter values used in Covid-19 example * Add greek letters to flow diagrams Fixes #29 * Remove reference to model library * Add flow diagrams to challenged answer * Add section on Vacamole model description * Add pak installation to setup chunks * Revert "Remove default lesson" This reverts commit 6eadba4. * Update config.yaml * Update renv.lock * Revert "Revert "Remove default lesson"" This reverts commit 8089e4c. * Revert "Update config.yaml" This reverts commit 4f2a8e1. * Update config.yaml * Fix typos * Fix typos * Style code * Improve figures * Remove {DiagrammeR} error message display * Move contact matrix definition * Colour nodes of vaccination classes * Fix typo * Rephrase documentation description * Update episodes/model-choices.Rmd Co-authored-by: Pratik Gupte <[email protected]> * Change title * Fix typo * Update title `model_choices.Rmd` * Fix typo * Add section on outcomes of interest * Update uncertainty section Updated code to run multiple model simulations to be the same as vignette and replaced {data.table} functions with `stat_summary()` stay within Tidyverse * update axis labels size * Add baseline trajectories to intervention figures * Minor rephrasing * Add details to effect of mask wearing calculation * Add resource links to concept dependencies * Add further detail to glossary definitions --------- Co-authored-by: rozeggo <[email protected]> Co-authored-by: Andree Valle Campos <[email protected]> Co-authored-by: Pratik Gupte <[email protected]>
Auto-generated via {sandpaper} Source : 237d7bb Branch : md-outputs Author : GitHub Actions <[email protected]> Time : 2023-10-31 16:15:02 +0000 Message : markdown source builds Auto-generated via {sandpaper} Source : 969a11b Branch : main Author : Amanda Minter <[email protected]> Time : 2023-10-31 15:37:33 +0000 Message : Late task tutorials (#34) * Created late task 1 episode file * Draft questions. objectives and section titles * Added notes on lesson content and provisional model equations * More lesson content to Model structures section * Outlines of remaining sections added * Edits to model structure section * Minor updates to model structures * Edits to introduction section * Add content to and reorder model parameters section * Added example plot to introduction * Minor edit to text * Add initial conditions section Added text and code to initial conditions section and updated initial plot to have same initial conditions * Reorder of sections * Updated text to introduction * Add generating trajectories section Added content to generating trajectories, which details specifying the initial conditions, demography vector and running the model * Added contact matrix section * Edits to tutorial content Content edits and reordering of some text * Changed naming of tutorial Updated name to simulating_transmission to better reflect tutorial content * Remove references from Rmd Citations have been changed to hyperlinks, so references no longer needed in Rmd header * Add file for `model_choices.Rmd` * Additions and edits to tutorial objectives * Update model_choices.Rmd Added tutorial content on all sections for Choosing a model * Update model_choices.Rmd Add 'Coming soon' to incomplete sections * Add uncertainty section Added section on how to account for uncertainty in R0 for influenza example * Fix typo * Add Comparing interventions tutorial * Remove default lesson * Update model_choices.Rmd Updated challenge outline to address #27 and to include Carpentries hint structure * Add glossary and add terms to `simulating_transmission` Glossary added in response to #24, additional transmission types added to `simulating_transmission` tutorial * Hide messages in output Fixes #26 for `simulating_transmission` and `compare_scenarios` * Update package and function notation Fixes #25 for current tutorials * Fix typo * Add function to view model names Fixes #23 * Add callout for exposed, infected, infectious Fixes #20 * Add instructor notes to tutorials Address #17 * Add concept dependencies to tutorials Addresses #19 * Add flow diagram of model equations Fixes #21 * Add definitions of outbreak and epidemic Added to `model_choices` tutorial and relevant definitions added to glossary * Add challenge to `model_choices` tutorial Fixes #14 * Remove reference to epidemic versus outbreak Keep tutorial content on the types of model used for epidemic versus outbreak analysis, but remove exact reference to epidemic and outbreak model types * Update intervention functions * Restructure tutorials Split `compare_interventions` into two tutorials : `modelling_interventions` and `compare_interventions` * Update outline of `compare_interventions` * Fix typo in ODE equations * Add section on mask wearing and vaccination Updates to school closure section as well as added sections on mask wearing and vaccination * typo and minor rephrase * Add updated ebola model definition * Update filenames Updating filenames to be consistent with the default naming of episodes from `create_episode` * Add to glossary terms Incubation period and latent period * Updates to parameter values used in Covid-19 example * Add greek letters to flow diagrams Fixes #29 * Remove reference to model library * Add flow diagrams to challenged answer * Add section on Vacamole model description * Add pak installation to setup chunks * Revert "Remove default lesson" This reverts commit 6eadba4. * Update config.yaml * Update renv.lock * Revert "Revert "Remove default lesson"" This reverts commit 8089e4c. * Revert "Update config.yaml" This reverts commit 4f2a8e1. * Update config.yaml * Fix typos * Fix typos * Style code * Improve figures * Remove {DiagrammeR} error message display * Move contact matrix definition * Colour nodes of vaccination classes * Fix typo * Rephrase documentation description * Update episodes/model-choices.Rmd Co-authored-by: Pratik Gupte <[email protected]> * Change title * Fix typo * Update title `model_choices.Rmd` * Fix typo * Add section on outcomes of interest * Update uncertainty section Updated code to run multiple model simulations to be the same as vignette and replaced {data.table} functions with `stat_summary()` stay within Tidyverse * update axis labels size * Add baseline trajectories to intervention figures * Minor rephrasing * Add details to effect of mask wearing calculation * Add resource links to concept dependencies * Add further detail to glossary definitions --------- Co-authored-by: rozeggo <[email protected]> Co-authored-by: Andree Valle Campos <[email protected]> Co-authored-by: Pratik Gupte <[email protected]>
Auto-generated via {sandpaper} Source : 969a11b Branch : main Author : Amanda Minter <[email protected]> Time : 2023-10-31 15:37:33 +0000 Message : Late task tutorials (#34) * Created late task 1 episode file * Draft questions. objectives and section titles * Added notes on lesson content and provisional model equations * More lesson content to Model structures section * Outlines of remaining sections added * Edits to model structure section * Minor updates to model structures * Edits to introduction section * Add content to and reorder model parameters section * Added example plot to introduction * Minor edit to text * Add initial conditions section Added text and code to initial conditions section and updated initial plot to have same initial conditions * Reorder of sections * Updated text to introduction * Add generating trajectories section Added content to generating trajectories, which details specifying the initial conditions, demography vector and running the model * Added contact matrix section * Edits to tutorial content Content edits and reordering of some text * Changed naming of tutorial Updated name to simulating_transmission to better reflect tutorial content * Remove references from Rmd Citations have been changed to hyperlinks, so references no longer needed in Rmd header * Add file for `model_choices.Rmd` * Additions and edits to tutorial objectives * Update model_choices.Rmd Added tutorial content on all sections for Choosing a model * Update model_choices.Rmd Add 'Coming soon' to incomplete sections * Add uncertainty section Added section on how to account for uncertainty in R0 for influenza example * Fix typo * Add Comparing interventions tutorial * Remove default lesson * Update model_choices.Rmd Updated challenge outline to address #27 and to include Carpentries hint structure * Add glossary and add terms to `simulating_transmission` Glossary added in response to #24, additional transmission types added to `simulating_transmission` tutorial * Hide messages in output Fixes #26 for `simulating_transmission` and `compare_scenarios` * Update package and function notation Fixes #25 for current tutorials * Fix typo * Add function to view model names Fixes #23 * Add callout for exposed, infected, infectious Fixes #20 * Add instructor notes to tutorials Address #17 * Add concept dependencies to tutorials Addresses #19 * Add flow diagram of model equations Fixes #21 * Add definitions of outbreak and epidemic Added to `model_choices` tutorial and relevant definitions added to glossary * Add challenge to `model_choices` tutorial Fixes #14 * Remove reference to epidemic versus outbreak Keep tutorial content on the types of model used for epidemic versus outbreak analysis, but remove exact reference to epidemic and outbreak model types * Update intervention functions * Restructure tutorials Split `compare_interventions` into two tutorials : `modelling_interventions` and `compare_interventions` * Update outline of `compare_interventions` * Fix typo in ODE equations * Add section on mask wearing and vaccination Updates to school closure section as well as added sections on mask wearing and vaccination * typo and minor rephrase * Add updated ebola model definition * Update filenames Updating filenames to be consistent with the default naming of episodes from `create_episode` * Add to glossary terms Incubation period and latent period * Updates to parameter values used in Covid-19 example * Add greek letters to flow diagrams Fixes #29 * Remove reference to model library * Add flow diagrams to challenged answer * Add section on Vacamole model description * Add pak installation to setup chunks * Revert "Remove default lesson" This reverts commit 6eadba4. * Update config.yaml * Update renv.lock * Revert "Revert "Remove default lesson"" This reverts commit 8089e4c. * Revert "Update config.yaml" This reverts commit 4f2a8e1. * Update config.yaml * Fix typos * Fix typos * Style code * Improve figures * Remove {DiagrammeR} error message display * Move contact matrix definition * Colour nodes of vaccination classes * Fix typo * Rephrase documentation description * Update episodes/model-choices.Rmd Co-authored-by: Pratik Gupte <[email protected]> * Change title * Fix typo * Update title `model_choices.Rmd` * Fix typo * Add section on outcomes of interest * Update uncertainty section Updated code to run multiple model simulations to be the same as vignette and replaced {data.table} functions with `stat_summary()` stay within Tidyverse * update axis labels size * Add baseline trajectories to intervention figures * Minor rephrasing * Add details to effect of mask wearing calculation * Add resource links to concept dependencies * Add further detail to glossary definitions --------- Co-authored-by: rozeggo <[email protected]> Co-authored-by: Andree Valle Campos <[email protected]> Co-authored-by: Pratik Gupte <[email protected]>
Auto-generated via {sandpaper} Source : dd92d5c Branch : md-outputs Author : GitHub Actions <[email protected]> Time : 2023-11-07 00:36:38 +0000 Message : markdown source builds Auto-generated via {sandpaper} Source : 969a11b Branch : main Author : Amanda Minter <[email protected]> Time : 2023-10-31 15:37:33 +0000 Message : Late task tutorials (#34) * Created late task 1 episode file * Draft questions. objectives and section titles * Added notes on lesson content and provisional model equations * More lesson content to Model structures section * Outlines of remaining sections added * Edits to model structure section * Minor updates to model structures * Edits to introduction section * Add content to and reorder model parameters section * Added example plot to introduction * Minor edit to text * Add initial conditions section Added text and code to initial conditions section and updated initial plot to have same initial conditions * Reorder of sections * Updated text to introduction * Add generating trajectories section Added content to generating trajectories, which details specifying the initial conditions, demography vector and running the model * Added contact matrix section * Edits to tutorial content Content edits and reordering of some text * Changed naming of tutorial Updated name to simulating_transmission to better reflect tutorial content * Remove references from Rmd Citations have been changed to hyperlinks, so references no longer needed in Rmd header * Add file for `model_choices.Rmd` * Additions and edits to tutorial objectives * Update model_choices.Rmd Added tutorial content on all sections for Choosing a model * Update model_choices.Rmd Add 'Coming soon' to incomplete sections * Add uncertainty section Added section on how to account for uncertainty in R0 for influenza example * Fix typo * Add Comparing interventions tutorial * Remove default lesson * Update model_choices.Rmd Updated challenge outline to address #27 and to include Carpentries hint structure * Add glossary and add terms to `simulating_transmission` Glossary added in response to #24, additional transmission types added to `simulating_transmission` tutorial * Hide messages in output Fixes #26 for `simulating_transmission` and `compare_scenarios` * Update package and function notation Fixes #25 for current tutorials * Fix typo * Add function to view model names Fixes #23 * Add callout for exposed, infected, infectious Fixes #20 * Add instructor notes to tutorials Address #17 * Add concept dependencies to tutorials Addresses #19 * Add flow diagram of model equations Fixes #21 * Add definitions of outbreak and epidemic Added to `model_choices` tutorial and relevant definitions added to glossary * Add challenge to `model_choices` tutorial Fixes #14 * Remove reference to epidemic versus outbreak Keep tutorial content on the types of model used for epidemic versus outbreak analysis, but remove exact reference to epidemic and outbreak model types * Update intervention functions * Restructure tutorials Split `compare_interventions` into two tutorials : `modelling_interventions` and `compare_interventions` * Update outline of `compare_interventions` * Fix typo in ODE equations * Add section on mask wearing and vaccination Updates to school closure section as well as added sections on mask wearing and vaccination * typo and minor rephrase * Add updated ebola model definition * Update filenames Updating filenames to be consistent with the default naming of episodes from `create_episode` * Add to glossary terms Incubation period and latent period * Updates to parameter values used in Covid-19 example * Add greek letters to flow diagrams Fixes #29 * Remove reference to model library * Add flow diagrams to challenged answer * Add section on Vacamole model description * Add pak installation to setup chunks * Revert "Remove default lesson" This reverts commit 6eadba4. * Update config.yaml * Update renv.lock * Revert "Revert "Remove default lesson"" This reverts commit 8089e4c. * Revert "Update config.yaml" This reverts commit 4f2a8e1. * Update config.yaml * Fix typos * Fix typos * Style code * Improve figures * Remove {DiagrammeR} error message display * Move contact matrix definition * Colour nodes of vaccination classes * Fix typo * Rephrase documentation description * Update episodes/model-choices.Rmd Co-authored-by: Pratik Gupte <[email protected]> * Change title * Fix typo * Update title `model_choices.Rmd` * Fix typo * Add section on outcomes of interest * Update uncertainty section Updated code to run multiple model simulations to be the same as vignette and replaced {data.table} functions with `stat_summary()` stay within Tidyverse * update axis labels size * Add baseline trajectories to intervention figures * Minor rephrasing * Add details to effect of mask wearing calculation * Add resource links to concept dependencies * Add further detail to glossary definitions --------- Co-authored-by: rozeggo <[email protected]> Co-authored-by: Andree Valle Campos <[email protected]> Co-authored-by: Pratik Gupte <[email protected]>
Tutorials on late tasks 1 and some of late tasks 2 using the R package
epidemics
. Merging into main so that @CarmenTamayo can perform a review from the live site.