Write scenario sheet

export_hpop_country_summary_xls Export a country-specific for HPOP billion.

Usage

write_scenario_sheet(
  df,
  wb = wb,
  billion = c("hep", "uhc", "hpop"),
  sheet_name = "Scenarios",
  start_row = 4,
  start_col = 2,
  value_col = "value",
  scenario_col = "scenario",
  ind_df,
  ind_ids,
  start_year = 2018,
  end_year = 2025,
  default_scenario = "default"
)

Arguments

df

data frame to be written

wb

a openxlsx workbook to be edited.

billion

Billion to be used for billion styling when relevant: either "hep", "hpop", or "uhc" when no billion to be applied.

sheet_name

character name of the sheet to update

start_row

integer start row of styling. Passed to openxlsx::addStyle()

start_col

integer start col of styling. Passed to openxlsx::addStyle()

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.

ind_df

data frame containing information on indicators

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().

start_year

Base year for contribution calculation, defaults to 2018.

end_year

End year(s) for contribution calculation, defaults to 2019 to 2025.

default_scenario

name of the default scenario.

Value

openxslx Workbook object. Output file is in output_folder.