R/zchunk_batch_Ccoef_xml.R

Defines functions module_energy_batch_Ccoef_xml

Documented in module_energy_batch_Ccoef_xml

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

#' module_energy_batch_Ccoef_xml
#'
#' Construct XML data structure for \code{Ccoef.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{Ccoef.xml}. The corresponding file in the
#' original data system was \code{batch_Ccoef_xml.R} (energy XML).
module_energy_batch_Ccoef_xml <- function(command, ...) {
  if(command == driver.DECLARE_INPUTS) {
    return(c("L202.CarbonCoef"))
  } else if(command == driver.DECLARE_OUTPUTS) {
    return(c(XML = "Ccoef.xml"))
  } else if(command == driver.MAKE) {

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

    # Load required inputs
    L202.CarbonCoef <- get_data(all_data, "L202.CarbonCoef")

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

    # Produce outputs
    create_xml("Ccoef.xml") %>%
      add_xml_data(L202.CarbonCoef, "CarbonCoef") %>%
      add_precursors("L202.CarbonCoef") ->
      Ccoef.xml

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