perform_item_data_processing: Perform iTEM data processing, producing region- and/or...

In transportenergy/item_mip_data_processing: R tools for constructing the iTEM databases

Perform iTEM data processing, producing region- and/or country-level database(s) from submitted model output

Description

This is a wrapper that performs all steps for inter-model harmonization in iTEM: data loading, pre-processing, determination of nation-level socioeconomic scenarios for downscaling, downscaling, computation of "All" subtotals, re-aggregation (if requested), deriving new variables from the existing set, and saving the output.

Usage

perform_item_data_processing(
  model_data_folder,
  model_names,
  output_folder,
  non_global_models = NA_character_,
  write_item_region_data = TRUE,
  write_item_country_data = FALSE,
  return_output = FALSE,
  spread_by_years = TRUE,
  ...
)

Arguments

model_data_folder	folder where the pre-processed model output data is located
output_folder	folder where the harmonized output dataset will be saved
write_item_region_data	logical (default = TRUE) indicating whether to write out a dataset aggregated to item reporting regions. If FALSE, no iTEM region level data will be returned.
write_item_country_data	logical (default = FALSE) indicating whether to write out a dataset with all variables reported at the country level. Warning: the dataset may be quite large.
return_output	logical (default = FALSE) indicating whether to return an object in the R environment
spread_by_years	logical (default = TRUE) indicating whether to "spread" the output so that the reporting years are columns and values are listed within the year columns

Details

This function applies nearly all other item downscaling functions. While it only requires a few arguments, any additional arguments provided will be passed to other functions. The list of functions called is provided here: load_preprocessed_data, prepare_preprocessed_data, load_country_region_mappings, compute_country_shares, assign_socioeconomic_scenario, downscale_flow_variables, extract_global_data_to_df, aggregate_all_permutations, aggregate_item_regions, derive_variables, save_output

transportenergy/item_mip_data_processing documentation built on July 6, 2023, 7:51 p.m.