untransform_uhc_data: Untransform Indicator Values for UHC Billion

View source: R/transform_uhc.R

untransform_uhc_dataR Documentation

Untransform Indicator Values for UHC Billion

Description

untransform_uhc_data() reverses transformations on UHC Billion indicators to return raw indicator values. Details on the specific transformations applied can be found within the Billions methods report.

Usage

untransform_uhc_data(
  df,
  transform_value_col = "transform_value",
  value_col = stringr::str_remove(transform_value_col, "transform_"),
  ind_ids = billion_ind_codes("uhc")
)

Arguments

df

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

transform_value_col

Column name(s) of column with transformed values to retrieve.

value_col

Column name(s) of column to place untransformed values. Must be same length as transform_value_col. If a column already exists, values are overwritten wherever ind and transform_value_col are available to be untransformed for this Billion, but otherwise, the column retains its other values.

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

For more details on the UHC Billion calculation process and how this function ties in with the rest, see the vignette:

vignette("uhc", package = "billionaiRe")

Value

Data frame in long format.

See Also

Other uhc: calculate_uhc_billion(), calculate_uhc_contribution(), transform_uhc_data(), transform_uhc_single(), uhc_df, untransform_uhc_single()


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