So that people don't overinterpret our models or vignettes, we should add a caveat to the readme. Something along the lines of:
"This package is intended solely for pedagogical purposes: most models of COVID-19 transmission used to decide policy are considerably more nuanced than those we include here, so please do not over-interpret our model structures, parameter values and vignettes. Of course, if you notice (say) a model structure or parameter value which seems wholly unreasonable, please feel free to open an issue."
More generally, the readme needs a bit of an update to: i) include an example usage of the package and ii) so that it's optimised for the website.
So that people don't overinterpret our models or vignettes, we should add a caveat to the readme. Something along the lines of:
"This package is intended solely for pedagogical purposes: most models of COVID-19 transmission used to decide policy are considerably more nuanced than those we include here, so please do not over-interpret our model structures, parameter values and vignettes. Of course, if you notice (say) a model structure or parameter value which seems wholly unreasonable, please feel free to open an issue."
More generally, the readme needs a bit of an update to: i) include an example usage of the package and ii) so that it's optimised for the website.
We also need to say that it's an R package!
Also add a link to the GUI.