RegisterBatchDataVimc: Creates .data.batch for running multiple birth cohorts (VIMC...

In lshtm-vimc/prime: PRIME -- Papillomavirus Rapid Interface for Modelling and Economics

Creates .data.batch for running multiple birth cohorts (VIMC runs)

Description

Creates .data.batch which is used when running/looping over multiple birth cohorts ( runCohort() ) at once. Similar to RegisterBatchData, but for when we make runs for VIMC.

Usage

RegisterBatchDataVimc(
  vimc_coverage,
  vimc_template,
  use_campaigns,
  use_routine,
  restrict_to_coverage_data = FALSE,
  force = FALSE,
  psa = 0
)

Arguments

vimc_coverage	data table with coverage estimates as downloaded from VIMC montagu
vimc_template	data table with reporting template as downloaded from VIMC montagu
use_campaigns	logical, whether campaigns as stated in coverage files should be modelled
use_routine	logical, whether routine vaccination as stated in coverage file should be modelled
restrict_to_coverage_data	logical, whether the first birth-cohort should be the first cohort that is mentioned in the coverage data. If TRUE, restrict to coverage data. If FALSE, restrict to cohorts provided in vimc_template.
force	logical, whether .data.batch should be overwritten if it already exists
psa	integer, indicating how many runs for probabilistic sensitivity analysis (PSA). 0 to run no PSA.

Details

.data.batch is based on the data.table (DT) coverage_data, which is a DT with columns country_code (ISO3), year (of vaccination), age_first (age at vaccination), age_last (age at vaccination), coverage (in proportion, for all the age groups specified).

Value

batch data of cohorts with vaccination coverage

Examples

#

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