search

epiverse-trace / finalsize

R package to calculate the final size of an SIR epidemic in populations with heterogeneity in social contacts and disease susceptibility
https://epiverse-trace.github.io/finalsize/
Other
11 stars 7 forks source link

Vignettes for finalsize #93

Closed pratikunterwegs closed 1 year ago

pratikunterwegs commented 2 years ago

This pull request adds vignettes for finalsize, and is a part of the project #91. Commits in this pull request add vignettes that cover:

  1. Basic usage of finalsize
  2. Modelling heterogeneous susceptibility within and between groups
  3. Modelling with uncertainty around R0

Together these are an initial fix for #9.

You can review the online form of the vignettes by cloning this repo, checking out the doc/vignettes branch, and building the pkgdown website:

git clone git@github.com:epiverse-trace/finalsize
git checkout doc/vignettes

In R:

pkgdown::build_site()
pratikunterwegs commented 1 year ago

I made a couple of tweaks to change 'you' to 'we' in the example descriptions, as that's my style preference, but feel free to ignore – main thing is to have consistency throughout.

Thanks @adamkucharski - I've included the edits and changed the style to 'we' - we can perhaps wait a bit for @avallecam in case he has any input? Otherwise if you could sign off on it we'll get this merged.