assert_data_calculation_hep: Assert presence of minimum HEP data

In gpw13/billionaiRe: Calculate the WHO Triple Billions

Assert presence of minimum HEP data

Description

assert_data_calculation_hep asserts that the minimum data required to run HEP calculations is present. This means checking that surviving_infants is present for all years where routine prevent indicators are present, and that espar start_year is not NA. Otherwise, errors will be returned by calculation functions.

Usage

assert_data_calculation_hep(
  df,
  value_col = "value",
  scenario_col = NULL,
  start_year = 2018,
  end_year = 2025,
  ind_ids = billion_ind_codes("hep")
)

Arguments

df	Data frame in long format, where 1 row corresponds to a specific country, year, and indicator.
value_col	Column name of column with indicator values.
scenario_col	Column name of column with scenario identifiers. Useful for calculating contributions on data in long format rather than wide format.
start_year	Base year for contribution calculation, defaults to 2018.
end_year	End year(s) for contribution calculation, defaults to 2019 to 2025.
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().

Details

The function returns warnings if espar and detect_respond start_year and end_year are not present in the data frame. Not having those values will significantly impact the billion calculations as hep_idx will not include them at all.

Warnings are also returned if some country (and scenario if provided) have only NAs.

Value

Data frame in long format.

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