scenario_bau: Scenario establish a business as usual scenario

In gpw13/billionaiRe: Calculate the WHO Triple Billions

Scenario establish a business as usual scenario

Description

scenario_bau filters for values between start_year and end_year for bau_scenario and returns values in value. If values are missing for years between start_year and end_year, the last available value will be imputed.

Usage

scenario_bau(
  df,
  only_reported_estimated = FALSE,
  value_col = "value",
  start_year = 2018,
  end_year = 2025,
  scenario_name = glue::glue("business_as_usual"),
  scenario_col = "scenario",
  avoid_worstening = FALSE,
  trim = TRUE,
  small_is_best = FALSE,
  keep_better_values = TRUE,
  upper_limit = 100,
  lower_limit = 0,
  trim_years = TRUE,
  start_year_trim = start_year,
  end_year_trim = end_year,
  ind_ids = billion_ind_codes("all"),
  bau_scenario = "historical",
  default_scenario = "default"
)

Arguments

df	Data frame in long format, where 1 row corresponds to a specific country, year, and indicator.
only_reported_estimated	(logical) if TRUE only the last reported and estimated values are imputed.
value_col	Column name of column with indicator values.
start_year	Start year for scenario, defaults to 2018.
end_year	End year for scenario, defaults to 2025
scenario_name	Name of the scenario. Defaults to scenario_percent_change_baseline_year
scenario_col	Column name of column with scenario identifiers. Useful for calculating contributions on data in long format rather than wide format.
avoid_worstening	If TRUE, the value at start_year is kept if it is better (see small_is_best).
trim	logical to indicate if the data should be trimmed between upper_limit and lower_limit.
small_is_best	Logical to identify if a lower value is better than a higher one (e.g. lower obesity in a positive public health outcome, so obesity rate should have small_is_best = TRUE).
keep_better_values	logical to indicate if "better" values should be kept from value_col if they are present. Follows the direction set in small_is_best. For instance, if small_is_best is TRUE, then value_col lower than col will be kept.
upper_limit	limit at which the indicator should be caped. Can take any of "guess", or any numeric. guess (default) will take 100 as the limit if percent_change is positive, and 0 if negative.
lower_limit	limit at which the indicator should be caped. Can take any of "guess", or 0 to 100. guess (default) will take 0 as the limit if percent_change is positive, and 100 if negative.
trim_years	logical to indicate if years before start_year_trim and after end_year_trim should be removed
start_year_trim	(integer) year to start trimming from.
end_year_trim	(integer) year to end trimming.
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().
bau_scenario	name of scenario to be used for business as usual. Default is historical.
default_scenario	name of the default scenario to be used.

See Also

Basic scenarios scenario_aroc(), scenario_best_of(), scenario_linear_change(), scenario_percent_baseline()

Comparing scenarios scenario_best_in_region(), scenario_best_of(), scenario_quantile()

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