RunCountry: Run PRIME for a specific country

RunCountryR Documentation

Run PRIME for a specific country

Description

Runs RunCohort() using country-specific estimates. If year_born and year_vac are not provided, assumes vaccination occurs in the current year.

Usage

RunCountry(
  country_iso3,
  vaceff_beforesexdebut = 1,
  vaceff_aftersexdebut = 0,
  cov = 1,
  agevac = 10,
  agecohort = 10,
  cohort = -1,
  canc.inc = "2020",
  sens = -1,
  unwpp_mortality = TRUE,
  year_born = -1,
  year_vac = -1,
  campaigns = -1,
  analyseCosts = FALSE,
  canc.cost = "unadj",
  discounting = FALSE,
  disc.cost = 0.03,
  disc.ben = 0.03,
  run_batch = FALSE,
  psadat = -1,
  disability.weights = "gbd_2017",
  wb.indicator = "NY.GDP.PCAP.PP.CD",
  wb.year = 2017,
  vaccine = "4vHPV"
)

Arguments

country_iso3

Character string (required): ISO3 code of the country

cov

Number (optional): Proportion with routine coverage

agevac

Integer (optional): Target age for HPV vaccination

agecohort

Integer (optional): Reference age for cohort-size (only used when 'cohort' is not provided)

cohort

Integer (optional): Cohort-size. -1 if unknown

canc.inc

Integer (optional): Reference year for cancer incidence rates (Globocan: 2020 or 2018 or 2012)

sens

Numeric-vector (optional): Specific values to be used in a PSA. -1 if PSA's are not used

unwpp_mortality

Logical (optional): If TRUE, uses year-specific UNWPP mortality estimates to construct life-tables. If FALSE, use WHO based mortality estimates.

year_born

Integer (optional): Year in which cohort is born

year_vac

Integer (optional): Year in which cohort is vaccinated

campaigns

List (optional): Multi-Age-Cohort campaigns (needs to be changed)

analyseCosts

Logical (optional): If FALSE, returns result from RunCohort() function. If TRUE, runs analyseCosts() with country-specific results.

canc.cost

Character (optional): Is cost of cancer adjusted ("adj" for International $) or not ("unadj" for US$)

discounting

Logical (optional): If TRUE, run cost-effectiveness analysis undiscounted and discounted. If FALSE, only uses undiscounted

disc.cost

Number (optional): Discounting for health costs (only if discounting=TRUE)

disc.ben

Number (optional): Discounting for health outcomes (only if discounting=TRUE)

disability.weights

character, disability weights for cervical cancer from GBD 2017 or GBD 2001

wb.indicator

character, World Bank indicator for GDP/GNI per capita in I$/US$ and current/constant data

wb.year

numeric, year of the World Bank indicator value

vaccine

character, bivalent/quadrivalent (4vHPV) or nonavalent (9vHPV) vaccine

vaceff

Number (optional): Proportion indicating vaccine-efficacy

Value

data.table with country-specific results of HPV vaccination. Returns cost-analysis if analyseCosts=TRUE

Examples

RunCountry("AFG")
RunCountry("AFG", year_vac=2020, agevac=10, cov=0.75, vaceff_beforesexdebut =0.88)
RunCountry("AFG", year_vac=2020, agevac=10, cov=0.75, vaceff_beforesexdebut =0.88,
          analyseCosts=TRUE)

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