vax_params_xvwrh: create vaccination parameters for use in onevax_xvwrh model

In mrc-ide/gonovax: Deterministic Compartmental Model of Gonorrhoea with Vaccination

create vaccination parameters for use in onevax_xvwrh model

Description

create vaccination parameters for use in onevax_xvwrh model

Usage

vax_params_xvwrh(
  vea = 0,
  vei = 0,
  ved = 0,
  ves = 0,
  vea_revax = vea,
  vei_revax = vei,
  ved_revax = ved,
  ves_revax = ves,
  dur = 1000,
  dur_revax = dur,
  primary_uptake = 0,
  booster_uptake = primary_uptake,
  strategy = NULL,
  vbe = 0,
  t_stop = 99,
  hes = 0,
  n_diag_rec = 1
)

Arguments

vea	scalar indicating efficacy of the vaccine against acquisition (between 0-1)
vei	scalar indicating efficacy of the vaccine against infectiousness (between 0-1)
ved	scalar indicating efficacy of the vaccine against duration (between 0-1)
ves	scalar indicating efficacy of the vaccine against symptoms (between 0-1)
vea_revax	scalar indicating efficacy of revaccination against acquisition (between 0-1)
vei_revax	scalar indicating efficacy of revaccination against infectiousness (between 0-1)
ved_revax	scalar indicating efficacy of revaccination against duration of infection (between 0-1)
ves_revax	scalar indicating efficacy of revaccination against symptoms (between 0-1)
dur	scalar indicating duration of the vaccine (in years)
dur_revax	duration of protection for revaccination, default to same as primary
primary_uptake	scalar or numeric vector with same length as 'gono_params' giving proportion of population undertaking primary vaccination as part of strategy
booster_uptake	scalar or numeric vector with same length as 'gono_params' giving proportion of population undertaking booster vaccination after primary vaccination protection has waned @param n_diag_rec integer for the number of diagnosis history substrata
strategy	single character string in "VoD", "VoD(H)", "VoA", "VoA(H)", "VoD(L)+VoA(H)". Defaults to NULL i.e. no vaccination
vbe	scalar indicating pc of population vaccinated before entry (between 0-1)
t_stop	time at which vaccination should stop (years)
hes	proportion of population vaccine hesitant
n_diag_rec	integer for the number of diagnosis history substrata

Value

A list parameters in the model input format

mrc-ide/gonovax documentation built on Dec. 15, 2024, 11:02 a.m.