R/zchunk_batch_Off_road_SSP_xml.R

In JGCRI/gcamdata: Build the GCAM Input Datasets

# Copyright 2019 Battelle Memorial Institute; see the LICENSE file.

#' module_energy_batch_Off_road_incelas_SSP_xml
#'
#' Construct XML data structures for all the \code{Off_road_incelas_SSP.xml} files.
#'
#' @param command API command to execute
#' @param ... other optional parameters, depending on command
#' @return Depends on \code{command}: either a vector of required inputs,
#' a vector of output names, or (if \code{command} is "MAKE") all
#' the generated outputs: \code{Off_road_incelas_gcam3.xml}, \code{Off_road_incelas_ssp1.xml}, \code{Off_road_incelas_ssp2.xml}, \code{Off_road_incelas_ssp3.xml},
#' \code{Off_road_incelas_ssp4.xml}, \code{Off_road_incelas_ssp5.xml}, \code{Off_road_incelas_gssp1.xml}, \code{Off_road_incelas_gssp2.xml},
#' \code{Off_road_incelas_gssp3.xml}, \code{Off_road_incelas_gssp4.xml}, and \code{Off_road_incelas_gssp5.xml}.
module_energy_batch_Off_road_incelas_SSP_xml <- function(command, ...) {

  INCOME_ELASTICITY_INPUTS <- c("GCAM3",
                                paste0("gSSP", 1:5),
                                paste0("SSP", 1:5))

  if(command == driver.DECLARE_INPUTS) {
    return(c(paste("L2324.Off_road_incelas", tolower(INCOME_ELASTICITY_INPUTS), sep = "_")))
  } else if(command == driver.DECLARE_OUTPUTS) {
    return(c(XML = "Off_road_incelas_gcam3.xml",
             XML = "Off_road_incelas_gssp1.xml",
             XML = "Off_road_incelas_gssp2.xml",
             XML = "Off_road_incelas_gssp3.xml",
             XML = "Off_road_incelas_gssp4.xml",
             XML = "Off_road_incelas_gssp5.xml",
             XML = "Off_road_incelas_ssp1.xml",
             XML = "Off_road_incelas_ssp2.xml",
             XML = "Off_road_incelas_ssp3.xml",
             XML = "Off_road_incelas_ssp4.xml",
             XML = "Off_road_incelas_ssp5.xml"))
  } else if(command == driver.MAKE) {

    # Silence package checks
    Off_road_incelas_gcam3.xml <- Off_road_incelas_ssp1.xml <- Off_road_incelas_ssp2.xml <- Off_road_incelas_ssp3.xml <-
      Off_road_incelas_ssp4.xml <- Off_road_incelas_ssp5.xml<- Off_road_incelas_gssp1.xml<- Off_road_incelas_gssp2.xml<-
      Off_road_incelas_gssp3.xml<- Off_road_incelas_gssp4.xml <- Off_road_incelas_gssp5.xml <- NULL

    all_data <- list(...)[[1]]

    # Loop through all the GCAM3, SSP, and gSSP objects and build the corresponding XML structure
    for(iei in INCOME_ELASTICITY_INPUTS) {
      data_obj <- paste0("L2324.Off_road_incelas_", tolower(iei))
      xmlfn <- paste0("Off_road_incelas_",tolower(iei), '.xml')

      create_xml(xmlfn) %>%
        add_xml_data(get_data(all_data, data_obj), "IncomeElasticity") %>%
        add_precursors(paste0("L2324.Off_road_incelas_", tolower(iei))) ->
        xml_obj

      # Assign output to output name
      assign(xmlfn, xml_obj)
    }

    return_data(Off_road_incelas_gcam3.xml,
                Off_road_incelas_ssp1.xml, Off_road_incelas_ssp2.xml, Off_road_incelas_ssp3.xml, Off_road_incelas_ssp4.xml, Off_road_incelas_ssp5.xml,
                Off_road_incelas_gssp1.xml, Off_road_incelas_gssp2.xml, Off_road_incelas_gssp3.xml, Off_road_incelas_gssp4.xml, Off_road_incelas_gssp5.xml)
  } else {
    stop("Unknown command")
  }
}