This depends on the DB format of VIMC and so is for internal use only.

calculate_impact(
  con,
  method,
  touchstone,
  modelling_group,
  disease,
  focal_scenario_type,
  baseline_scenario_type,
  focal_vaccine_delivery = NULL,
  baseline_vaccine_delivery = NULL,
  burden_outcomes = c("deaths", "cases", "dalys"),
  countries = NULL,
  is_under5 = FALSE,
  vaccination_years = 2000:2030
)

Arguments

con

Connection to database.

method

Impact method to use one of calendar_year, birth_year, yov_activity_type, yov_birth_cohort.

touchstone

The montagu touchstone to calculate impact for. Either touchstone ID or touchstone name.

modelling_group

The modelling group to calculate impact for.

disease

The disease to calculate impact for.

focal_scenario_type

The focal scenario scenario type e.g. "default"

baseline_scenario_type

The baseline scenario scenario type e.g. "novac"

focal_vaccine_delivery

The focal vaccine delivery methods. This should be a list of lists or NULL if scenario type is novac. Each element of first list needs to specify the vaccination and activity type. e.g. list( list( vaccine = "HepB", activity_type = "routine" ), list( vaccine = "HepB_BD", activity_type = "routine" ) )

baseline_vaccine_delivery

Like `focal_vaccine_delivery` this should be a list of lists, each element containing vaccination and activity type. If `baseline_vaccine_delivery` is `novac` then this should be NULL.

burden_outcomes

List of burden outcomes, defaults to "deaths", "cases" and "dalys".

countries

Vector of countries to get impact for. If NULL then impact calculated for all countries.

is_under5

If TRUE then only include data for age under 5, otherwise calculate impact for all ages

vaccination_years

Years of vaccination of interest, only used for year of vaccination (yov) methods

Value

Impact for this set of parameters.