R/zchunk_batch_trn_ghg_emissions_USA_xml.R

Defines functions module_gcamusa_batch_trn_ghg_emissions_USA_xml

Documented in module_gcamusa_batch_trn_ghg_emissions_USA_xml

#' module_gcamusa_batch_trn_ghg_emissions_USA_xml
#'
#' Construct XML data structure for \code{othertrn_emissions_USA.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{trn_ghg_emissions_USA.xml}. The corresponding file in the
#' original data system was \code{batch_transport_emissions_USA_xml.R} (gcamusa XML).
module_gcamusa_batch_trn_ghg_emissions_USA_xml <- function(command, ...) {
  if(command == driver.DECLARE_INPUTS) {
    return(c("L271.ghg_trn_tech_coeff_USA"))
  } else if(command == driver.DECLARE_OUTPUTS) {
    return(c(XML = "trn_ghg_emissions_USA.xml"))
  } else if(command == driver.MAKE) {

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

    # Load required inputs
    L271.ghg_trn_tech_coeff_USA <- get_data(all_data, "L271.ghg_trn_tech_coeff_USA")

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

    # Produce outputs
    create_xml("trn_ghg_emissions_USA.xml") %>%
      add_xml_data(L271.ghg_trn_tech_coeff_USA, "TrnInputEmissCoeff") %>%
      add_precursors("L271.ghg_trn_tech_coeff_USA") ->
      trn_ghg_emissions_USA.xml

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