source commit: 2137f56

CODE_OF_CONDUCT.md

@@ -0,0 +1,15 @@
+---
+title: "Contributor Code of Conduct"
+---
+
+As contributors and maintainers of this project,
+we pledge to follow the [The Epiverse-TRACE Code of Conduct][coc].
+
+<!--
+Instances of abusive, harassing, or otherwise unacceptable behavior
+may be reported by following our [reporting guidelines][coc-reporting].
+-->
+
+[coc-reporting]: https://forms.gle/guKqVXPk6K43jPn59
+[coc]: https://github.com/epiverse-trace/.github/blob/main/CODE_OF_CONDUCT.md
+

LICENSE.md

@@ -0,0 +1,74 @@
+---
+title: "Licenses"
+---
+
+## Instructional Material
+
+The tutorials in this repository are developed by Epiverse-TRACE, based on the [lesson template from the Carpentries](https://github.com/carpentries/workbench-template-rmd) (template under CC BY license).
+
+All Epiverse-TRACE
+instructional material is made available under the [Creative Commons
+Attribution license][cc-by-human]. The following is a human-readable summary of
+(and not a substitute for) the [full legal text of the CC BY 4.0
+license][cc-by-legal].
+
+You are free:
+
+- to **Share**---copy and redistribute the material in any medium or format
+- to **Adapt**---remix, transform, and build upon the material
+
+for any purpose, even commercially.
+
+The licensor cannot revoke these freedoms as long as you follow the license
+terms.
+
+Under the following terms:
+
+- **Attribution**---You must give appropriate credit (mentioning that your work
+  is derived from work that is Copyright (c) Epiverse-TRACE, where
+  practical, linking to <https://epiverse-trace.github.io/>), provide a [link to the
+  license][cc-by-human], and indicate if changes were made. You may do so in
+  any reasonable manner, but not in any way that suggests the licensor endorses
+  you or your use.
+
+- **No additional restrictions**---You may not apply legal terms or
+  technological measures that legally restrict others from doing anything the
+  license permits.  With the understanding that:
+
+Notices:
+
+* You do not have to comply with the license for elements of the material in
+  the public domain or where your use is permitted by an applicable exception
+  or limitation.
+* No warranties are given. The license may not give you all of the permissions
+  necessary for your intended use. For example, other rights such as publicity,
+  privacy, or moral rights may limit how you use the material.
+
+## Software
+
+Except where otherwise noted, the example programs and other software provided
+by Epiverse-TRACE are made available under the [OSI][osi]-approved [MIT
+license][mit-license].
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
+[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
+[mit-license]: https://opensource.org/licenses/mit-license.html
+[osi]: https://opensource.org

compare-interventions.md

@@ -0,0 +1,110 @@
+---
+title: 'Comparing public health outcomes of interventions'
+teaching: 45 # teaching time in minutes
+exercises: 30 # exercise time in minutes
+
+---
+
+
+
+:::::::::::::::::::::::::::::::::::::: questions 
+
+- How can I quantify the effect of an intervention?
+
+
+::::::::::::::::::::::::::::::::::::::::::::::::
+
+::::::::::::::::::::::::::::::::::::: objectives
+
+- Understand how to compare intervention scenarios
+
+::::::::::::::::::::::::::::::::::::::::::::::::
+
+::::::::::::::::::::::::::::::::::::: prereq
+
+## Prerequisites
++ Complete tutorials [Simulating transmission](../episodes/simulating-transmission.md) and [Modelling interventions](../episodes/modelling-interventions.md)
+
+This tutorial has the following concept dependencies:
+
+**Outbreak response** : [Intervention types](https://www.cdc.gov/nonpharmaceutical-interventions/).
+:::::::::::::::::::::::::::::::::
+
+
+## Introduction
+
+In this tutorial we will compare intervention scenarios against each other. To quantify the effect of the intervention we need to compare our intervention scenario to a counter factual scenario. The *counter factual* is the scenario in which nothing changes, often referred to as the 'do nothing' scenario. The counter factual scenario may include no interventions, or if we are investigating the potential impact of an additional intervention in the later stages of an outbreak there may be existing interventions in place. 
+
+We must also decide what our *outcome of interest* is to make comparisons between intervention and counter factual scenarios. The outcome of interest can be:
+
++ a model outcome, e.g. number of infections or hospitalisations,
++ a metric such as the epidemic peak time or size,
++ a measure that uses the model outcomes such as QALY/DALYs.
+
+
+:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: instructor
+
+In this tutorial we introduce the concept of the counter factual and how to compare scenarios (counter factual versus intervention) against each other. 
+
+::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+
+## Vacamole model
+
+The Vacamole model is a deterministic model based on a system of ODEs in [Ainslie et al. 2022]( https://doi.org/10.2807/1560-7917.ES.2022.27.44.2101090). The model consists of 11 compartments, individuals are classed as one of the following:
+
++ susceptible, $S$,
++ partial vaccination ($V_1$), fully vaccination ($V_2$),
++ exposed, $E$ and exposed while vaccinated, $E_V$,
++ infectious, $I$ and infectious while vaccinated, $I_V$,
++ hospitalised, $H$ and hospitalised while vaccinated, $H_V$,
++ dead, $D$,
++ recovered, $R$.
+
+The diagram below describes the flow of individuals through the different compartments. 
+
+<img src="fig/compare-interventions-rendered-unnamed-chunk-1-1.png" style="display: block; margin: auto;" />
+
+See `?epidemics::model_vacamole_cpp` for detail on how to run the model. 
+
+## Comparing scenarios
+
+*Coming soon*
+
+## Challenge
+
+*Coming soon*
+
+<!-- ::::::::::::::::::::::::::::::::::::: challenge -->
+
+<!-- ## The effect of vaccination on COVID-19 hospitalisations   -->
+
+
+
+<!-- ::::::::::::::::: hint -->
+
+<!-- ### HINT -->
+
+
+<!-- :::::::::::::::::::::: -->
+
+
+<!-- ::::::::::::::::: solution -->
+
+<!-- ### SOLUTION -->
+
+
+
+
+
+<!-- ::::::::::::::::::::::::::: -->
+
+
+<!-- :::::::::::::::::::::::::::::::::::::::::::::::: -->
+
+
+
+::::::::::::::::::::::::::::::::::::: keypoints 
+
+- The counter factual scenario must be defined to make comparisons
+
+::::::::::::::::::::::::::::::::::::::::::::::::

config.yaml

@@ -0,0 +1,81 @@
+#------------------------------------------------------------
+# Values for this lesson.
+#------------------------------------------------------------
+
+# Which carpentry is this (swc, dc, lc, or cp)?
+# swc: Software Carpentry
+# dc: Data Carpentry
+# lc: Library Carpentry
+# cp: Carpentries (to use for instructor training for instance)
+# incubator: The Carpentries Incubator
+carpentry: 'incubator'
+
+# Overall title for pages.
+title: 'Outbreak analytics with R'
+
+# Date the lesson was created (YYYY-MM-DD, this is empty by default)
+created: ~
+
+# Comma-separated list of keywords for the lesson
+keywords: 'forecasts, epidemic models, interventions' #FIXME
+
+# Life cycle stage of the lesson
+# possible values: pre-alpha, alpha, beta, stable
+life_cycle: 'pre-alpha'
+
+# License of the lesson
+license: 'CC-BY 4.0' #FIXME
+
+# Link to the source repository for this lesson
+source: 'https://github.com/epiverse-trace/tutorials'
+
+# Default branch of your lesson
+branch: 'main'
+
+# Who to contact if there are any issues
+contact: '[email protected]' #FIXME
+
+# Navigation ------------------------------------------------
+#
+# Use the following menu items to specify the order of
+# individual pages in each dropdown section. Leave blank to
+# include all pages in the folder.
+#
+# Example -------------
+#
+# episodes:
+# - introduction.md
+# - first-steps.md
+#
+# learners:
+# - setup.md
+#
+# instructors:
+# - instructor-notes.md
+#
+# profiles:
+# - one-learner.md
+# - another-learner.md
+
+# Order of episodes in your lesson
+episodes:
+- simulating-transmission.Rmd
+- model-choices.Rmd
+- modelling-interventions.Rmd
+- compare-interventions.Rmd
+
+# Information for Learners
+learners:
+
+# Information for Instructors
+instructors:
+
+# Learner Profiles
+profiles:
+
+# Customisation ---------------------------------------------
+#
+# This space below is where custom yaml items (e.g. pinning
+# sandpaper and varnish versions) should live
+varnish: epiverse-trace/varnish@epiversetheme
+sandpaper: 'carpentries/sandpaper#533'