untransform_hpop_data: Untransform Indicator Values for HPOP Billion

In gpw13/billionaiRe: Calculate the WHO Triple Billions

Untransform Indicator Values for HPOP Billion

Description

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

Usage

untransform_hpop_data(
  df,
  transform_value_col = "transform_value_col",
  value_col = stringr::str_remove(transform_value_col, "transform_"),
  ind_ids = billion_ind_codes("hpop")
)

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 HPOP Billion calculation process and how this function ties in with the rest, see the vignette:

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

Value

Data frame in long format.

See Also

Other hpop: add_hpop_populations(), calculate_hpop_billion_change(), calculate_hpop_billion(), calculate_hpop_contributions(), hpop_df, transform_hpop_data(), transform_hpop_single(), untransform_hpop_single()

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