Skip to content

Contains an SEIRV model stratified by age and region, implemented in odin_dust, along with functions to fit the model to case data, and generate stochastic simulations.

License

Notifications You must be signed in to change notification settings

krosenfeld-IDM/seirvodin

Repository files navigation

seirvodin

seirvodin presents a compartmental model implemented in odin_dust, this model is stratified by age, region and vaccination status. The model was used in Robert et al, Lancet Public Health, 2024. The structure of the model is presented in the figure below:

Structure of the model for a given age and region (From Robert et al, Lancet Public Health, 2024)

seirvodin can be used to fit the model to case data, or generate stochastic (or deterministic) simulations. It was designed to analyse measles outbreaks, and therefore expects routine coverage data (for first and second dose). It can estimate the coverage of catchup campaigns prior the start of fitting (or simulations), but does not explicitly allow catchup campaigns during the fitting period (but the coverage of catchup campaigns could be integrated in the routine coverage data).

Installation

To install the development version from github (requires Rtools on windows and GSL headers on all platforms):

devtools::install_github("alxsrobert/seirvodin")

Documentation

Five functions from seirvodin are exported:

  • seirv_age_region: dust compartmental model stratified by age and region.
  • run_model(): Function to fit the model to case data.
  • generate_outbreaks(): Function to generate stochastic or deterministic simulations from the parameter set estimated during the model fitting process.
  • specs_run(): Function to generate the specifications of the model fitting.
  • specs_simulations(): Function to generate the specifications of the simulations.

The seirv_age_region model expects at least 9 parameters, and has several optional parameters:

  • beta: Infection rate.
  • delta: 1/Duration of maternal immunity.
  • X: Seasonality of infection rate.
  • Y: Seasonality of infection rate.
  • X_import: Seasonality of importations.
  • Y_import: Seasonality of importations.
  • v_fail: Proportion of primary vaccine failure.
  • vacc: Risk of onward transmission from vaccinated cases, compared to unvaccinated cases.
  • report_import: Proportion of importations reported
  • b: (optional) Spatial parameter.
  • c: (optional) Spatial parameter.
  • theta: (optional) Spatial parameter.
  • v_leak: (optional) Waning of immunity per year (set to 0 if not set by the user).
  • v_sec: (optional) Baseline risk of secondary vaccine failure (set to 0 if not set by the user).
  • recov_X: (optional) Proportion of individuals starting as recovered in a given age group, X corresponds to the age group targeted (e.g. recov_7 corresponds to the proportion of individuals in the seventh age group who will start as recovered).
  • catchup_X: (optional) Proportion of individuals vaccinated during a catch-up campaign (moving from V1 to V2) in a given age group, X corresponds to the age group targeted (e.g. catchup_7 corresponds to the proportion of individuals (in V1) in the seventh age group targeted by the catch-up campaign who will move to V2).
  • catchup2_X: (optional) Proportion of individuals vaccinated during a catch-up campaign (moving from S and V1 to V2) in a given age group, X corresponds to the age group targeted (e.g. catchup2_7 corresponds to the proportion of individuals (in V1 or S) in the seventh age group targeted by the catch-up campaign who will move to V2).
  • v_X: (optional) Proportion of individuals vaccinated (moving from S to V1) in a given age group, X corresponds to the age group targeted (e.g. v_7 corresponds to the proportion of individuals (in S) in the seventh age group targeted by the catch-up campaign who will move to V1).

About

Contains an SEIRV model stratified by age and region, implemented in odin_dust, along with functions to fit the model to case data, and generate stochastic simulations.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published