R/primary_energy.R

In JGCRI/iamrpt: Convert GCAM results to the format required by various IAM experiment databases

#### Data modules for the primary energy group

#' Primary Energy (Direct Equivalent) Data Module
#'
#' Produce primary energy by fuel
#'
#' The raw table used by this module has columns:
#' \itemize{
#'   \item{scenario}
#'   \item{region}
#'   \item{year}
#'   \item{value}
#'   \item{Units}
#' }
#'
#' @keywords internal

module.primary_energy_direct <- function(mode, allqueries, aggkeys, aggfn,
                                         years, filters, ounit)
{
    if(mode == GETQ) {
        # Return titles of necessary queries
        # For more complex variables, will return multiple query titles in vector
        'Primary Energy Consumption (Direct Equivalent)'
    }
    else {
        ## silence notes on package checks
        fuel <- NULL

        message('Function for processing variable: Primary Energy')
        pe <- allqueries$'Primary Energy Consumption (Direct Equivalent)' %>%
              dplyr::mutate(fuel = simplify_fuels(fuel))
        pe <- filter(pe, years, filters)
        pe <- aggregate(pe, aggfn, aggkeys)
        if(!is.na(ounit)) {
            ## skip unit conversion if output unit not specified.
            cfac <- unitconv_energy(pe$Units[1], ounit)
            if(!is.na(cfac)) {
                pe$value <- pe$value * cfac
                pe$Units <- ounit
            }
        }
        pe
    }
}

simplify_fuels <- function(fuel) {
    fuel <- sub('-elect renewable', '', fuel)
    fuel <- sub('-H2 renewable', '', fuel)
    fuel <- sub('hydro CCS', 'hydro', fuel)
    fuel <- sub('solar CCS', 'solar', fuel)
    fuel <- sub('wind CCS', 'wind', fuel)
    fuel <- sub('nuclear CCS', 'nuclear', fuel)
    fuel <- sub('.* oil', 'oil', fuel)
    fuel <- sub('.*corn.*', 'biomass', fuel)
    fuel <- sub('.*sugar.*', 'biomass', fuel)
    fuel <- sub('biomassOil', 'biomass', fuel)
    fuel <- sub('regional ', '', fuel)
}