R/zchunk_batch_water_supply_uncalibrated_xml.R

In JGCRI/gcamdata: Build the GCAM Input Datasets

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

#' module_water_batch_water_supply_uncalibrated_xml
#'
#' Construct XML data structure for \code{water_supply_uncalibrated.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{water_supply_uncalibrated.xml}. The corresponding file in the
#' original data system was \code{batch_water_supply_uncalibrated.xml} (water XML).
module_water_batch_water_supply_uncalibrated_xml <- function(command, ...) {
  if(command == driver.DECLARE_INPUTS) {
    return(c("L201.DeleteUnlimitRsrc",
             "L201.Rsrc",
             "L201.RsrcPrice",
             "L201.RenewRsrcCurves_uncalibrated",
             "L201.GrdRenewRsrcMax_runoff",
             "L201.DepRsrcCurves_ground_uniform"))
  } else if(command == driver.DECLARE_OUTPUTS) {
    return(c(XML = "water_supply_uncalibrated.xml"))
  } else if(command == driver.MAKE) {

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

    # Load required inputs
    L201.DeleteUnlimitRsrc <- get_data(all_data, "L201.DeleteUnlimitRsrc")
    L201.Rsrc <- get_data(all_data, "L201.Rsrc")
    L201.RsrcPrice <- get_data(all_data, "L201.RsrcPrice")
    L201.RenewRsrcCurves_uncalibrated <- get_data(all_data, "L201.RenewRsrcCurves_uncalibrated")
    L201.GrdRenewRsrcMax_runoff <- get_data(all_data, "L201.GrdRenewRsrcMax_runoff")
    L201.DepRsrcCurves_ground_uniform <- get_data(all_data, "L201.DepRsrcCurves_ground_uniform")

    resource <- NULL    # silence package check notes

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

    # Produce outputs
    create_xml("water_supply_uncalibrated.xml") %>%
      add_node_equiv_xml("resource") %>%
      add_xml_data(L201.DeleteUnlimitRsrc, "DeleteUnlimitRsrc") %>%
      add_xml_data(L201.Rsrc, "Rsrc") %>%
      add_xml_data(L201.RsrcPrice, "RsrcPrice") %>%
      # Note we are going to use the RenewRsrcCurves header to avoid having to create
      # duplicate headers.  The resource type will remain "resource" because we set
      # the "resource" node_equiv_xml above.  However we still need to set the
      # column names appropriately if we want the column re-ordering to work.
      add_xml_data(L201.RenewRsrcCurves_uncalibrated %>% rename(renewresource = resource), "RenewRsrcCurves") %>%
      add_xml_data(L201.GrdRenewRsrcMax_runoff, "GrdRenewRsrcMaxNoFillOut") %>%
      add_xml_data(L201.DepRsrcCurves_ground_uniform, "RsrcCurves") %>%
      add_precursors("L201.DeleteUnlimitRsrc",
                     "L201.Rsrc",
                     "L201.RsrcPrice",
                     "L201.RenewRsrcCurves_uncalibrated",
                     "L201.GrdRenewRsrcMax_runoff",
                     "L201.DepRsrcCurves_ground_uniform") ->
      water_supply_uncalibrated.xml


    return_data(water_supply_uncalibrated.xml)
  } else {
    stop("Unknown command")
  }
}