EstimateVaccineImpactVimcCentral: Generate vaccine impact estimates - HPV 16/18 types (VIMC...

EstimateVaccineImpactVimcCentralR Documentation

Generate vaccine impact estimates - HPV 16/18 types (VIMC central run)

Description

Generate vaccine impact estimates (HPV 16/18 types) for VIMC central runs. The inputs are vaccine coverage and disease burden template files and outputs are disease burden estimates (pre-vaccination and post-vaccination).

Usage

EstimateVaccineImpactVimcCentral(
  vaccine_coverage_file,
  disease_burden_template_file,
  disease_burden_no_vaccination_file,
  disease_burden_vaccination_file,
  disease_burden_results_file,
  campaign_vaccination,
  routine_vaccination,
  vaccine = "4vHPV",
  canc.inc = "2020",
  country_set = "all"
)

Arguments

vaccine_coverage_file

csv file (input), vaccine coverage data (vimc format)

disease_burden_template_file

csv file (input), disease burden template (vimc format)

disease_burden_no_vaccination_file

csv file (output), disease burden estimates for no vaccination (vimc format)

disease_burden_vaccination_file

csv file (output), disease burden estimates for vaccination (vimc format)

disease_burden_results_file

csv file (output), disease burden estimates pre-vaccination and post-vaccination

campaign_vaccination

logical, indicates campaign vaccination

routine_vaccination

logical, indicates routine vaccination

vaccine

character, bivalent/quadrivalent/nonovalent HPV vaccine

canc.inc

character, year of GLOBOCAN estimates

country_set

character, run for all countries specified in disease burden template file (or) run for a set of countries

Details

Three disease burden estimates (HPV 16/18 types) are generated. (i) disease burden estimates for no vaccination (vimc format) (ii) disease burden estimates for vaccination (vimc format) (iii) disease burden estimates for vaccination (pre- and post-vaccination) and includes YLDs and YLLs

Value

Null return value; disease burden estimates are saved to corresponding files

Examples

  EstimateVaccineImpactVimcCentral (
    vaccine_coverage_file              = "coverage_hpv-routine-default.csv",
    disease_burden_template_file       = "central-burden-template.csv",
    disease_burden_no_vaccination_file = "central_burden_no_vaccination.csv",
    disease_burden_vaccination_file    = "central_burden_vaccination.csv",
    disease_burden_results_file        = "central_burden_results.csv",
    routine_vaccination                = TRUE,
    campaign_vaccination               = TRUE)


lshtm-vimc/prime documentation built on April 21, 2024, 3:21 a.m.