pathogen_calc: Calculate the vaccine coverage for a specific pathogen

View source: R/calculate_hep_components.R

pathogen_calcR Documentation

Calculate the vaccine coverage for a specific pathogen

Description

Using numerators and denominators pre-supplied for each ISO3 and year, the overall vaccine coverage for a pathogen is calculated. This function currently counts the number of routine vaccinations included in the numerator, and multiplies the surviving infants denominator by that number.

Usage

pathogen_calc(
  df,
  name,
  numerators,
  denominators,
  transform_value_col,
  source,
  ind_ids,
  multiply_surviving_infs,
  max_value
)

Arguments

df

Data frame in long format, where 1 row corresponds to a specific country, year, and indicator.

name

Name of pathogen to provide in the data frame.

numerators

Indicator names for numerators.

denominators

Indicator names for denominators.

transform_value_col

Column name of column(s) with transformed indicator values, used to calculate contributions.

source

Source to use if no unique source available for the calculation.

ind_ids

Named vector of indicator codes for input indicators to the Billion. Although separate indicator codes can be used than the standard, they must be supplied as a named vector where the names correspond to the output of billion_ind_codes().

multiply_surviving_infs

Logical, multiple surviving infant population by number of routine vaccines in numerator.

max_value

Maximum value the calculated pathogen value can take.

Details

This function is currently called from the calculate_hep_prevent_ind() function that sits within calculate_hep_components().


gpw13/billionaiRe documentation built on Sept. 27, 2024, 10:05 p.m.