R/zchunk_batch_solar_low_xml.R

Defines functions module_energy_batch_solar_low_xml

Documented in module_energy_batch_solar_low_xml

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

#' module_energy_batch_solar_low_xml
#'
#' Construct XML data structure for \code{solar_low.xml}.
#'
#' @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{solar_low.xml}. The corresponding file in the
#' original data system was \code{batch_solar_low_xml.R} (energy XML).
module_energy_batch_solar_low_xml <- function(command, ...) {
  if(command == driver.DECLARE_INPUTS) {
    return(c("L223.GlobalTechCapital_sol_low",
              "L223.GlobalIntTechCapital_sol_low"))
  } else if(command == driver.DECLARE_OUTPUTS) {
    return(c(XML = "solar_low.xml"))
  } else if(command == driver.MAKE) {

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

    # Load required inputs
    L223.GlobalTechCapital_sol_low <- get_data(all_data, "L223.GlobalTechCapital_sol_low")
    L223.GlobalIntTechCapital_sol_low <- get_data(all_data, "L223.GlobalIntTechCapital_sol_low")

    # ===================================================

    # Produce outputs
    create_xml("solar_low.xml") %>%
      add_xml_data(L223.GlobalTechCapital_sol_low, "GlobalTechCapital") %>%
      add_xml_data(L223.GlobalIntTechCapital_sol_low, "GlobalIntTechCapital") %>%
      add_precursors("L223.GlobalTechCapital_sol_low", "L223.GlobalIntTechCapital_sol_low") ->
      solar_low.xml

    return_data(solar_low.xml)
  } else {
    stop("Unknown command")
  }
}
JGCRI/gcamdata documentation built on March 21, 2023, 2:19 a.m.