setup_inputs: process inputs to run simulation

Description Usage Arguments Value

View source: R/setup.R

Description

process inputs to run simulation

Usage

1
2
3
setup_inputs(simulation_flags, life_history_params, travel_params,
  seed_params, user_specified_cum_vax_pool_func, vax_production_params,
  user_specified_vax_alloc_func, vax_allocation_params)

Arguments

simulation_flags

named vector (or list) with the logical elements "normaliseTravel" "seasonal" and "real_data"

life_history_params

named vector (or list) with the numeric elements "R0", "TR" (time to recovery) and "LP" (latent period)

travel_params

list of parameters relating to travel. This should have the following elements: 1) epsilon, which scales the off-diagonals of the travel matrix

seed_params

named vector (or list) of parameters to do with seeding the pandemic. contains the elements seedCountries: vector of country names in which to seed

user_specified_cum_vax_pool_func

function or character string of function to produce vaccine pool

vax_production_params

named vector (or list) with named elements matching the arguments of user_specified_cum_vax_pool_func

user_specified_vax_alloc_func

function or character string of function to allocate vaccines

vax_allocation_params

named vector (or list) with named elements matching the arguments of user_specified_vax_alloc_func

time_params

list of parameters to do with time steps in simulation.

seasonality_params

list of seasonality parameters. contains the elements tdelay (0 <= tdelay <= 364): shifts the seasonality function - changing this effectively changes the seed time. tdelay = 0 is seed at t = 0 in sinusoidal curve, roughly start of autumn in Northern hemisphere division: Average seasonality into this many blocks of time amp: amplitude of seasonality

vax_params

named vector (or list) with the numeric elements "efficacy" and "propn_vax0" (initial proportion of vaccinated individuals; assumed constant across location, age and risk groups)

Value

a list of arguments to go into run_simulation


jameshay218/vaxedemic documentation built on Jan. 30, 2020, 2:58 a.m.