billion_ind_codes: Indicator codes for the Billions

View source: R/data_access.R

billion_ind_codesR Documentation

Indicator codes for the Billions

Description

Provides analysis codes required for input into the Triple Billion calculations. The named vector returned by the function is the default names assumed to be in any data frame passed to calculate Billions.

Usage

billion_ind_codes(
  billion = c("hep", "hpop", "uhc", "all"),
  include_covariates = FALSE,
  include_calculated = FALSE,
  include_subindicators = TRUE
)

Arguments

billion

(string) Billion indicator names to return, either "hep", "hpop", or "uhc".

include_covariates

(logical) Whether or not to include covariates when getting the Billions indicator codes.

include_calculated

(logical) Whether or not to include variables calculated from within the package when getting the Billion indicator codes. Useful for UHC average service coverage.

include_subindicators

(logical) Whether to return subindicators, such as those ending with _rural, _urban, _num, _denom, and the espar categories and sub-categories.

Value

Character vector of indicator names.

See Also

Functions to access metadata convert_ind_codes(), get_country_shares(), get_ind_billion(), get_ind_metadata(), get_sdi_ratio(), indicator_df


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