verify_IEATable_energy_balance: Confirm that an IEA-style data frame conserves energy.

In MatthewHeun/Recca: R Energy Conversion Chain Analysis

Confirm that an IEA-style data frame conserves energy.

Description

Energy balances are confirmed (within tol) for every combination of grouping variables in .ieatidydata.

Usage

verify_IEATable_energy_balance(
  .ieatidydata,
  LedgerSide = IEATools::iea_cols$ledger_side,
  energy = IEATools::iea_cols$e_dot,
  supply = "Supply",
  consumption = "Consumption",
  err = ".err",
  tol = 1e-06
)

Arguments

.ieatidydata	an IEA-style data frame containing grouping columns (typically Country, Year, Product, and others), a LedgerSide column, and an energy column (E.ktoe). .ieatidydata should be grouped prior to sending to this function.
LedgerSide	the name of the column in .ieatidydata that contains ledger side information (a string). Default is "LedgerSide".
energy	the name of the column in .ieatidydata that contains energy data (a string). Default is "E.ktoe".
supply	the identifier for supply data in the LedgerSide column (a string). Default is "Supply".
consumption	the identifier for consumption data in the LedgerSide column (a string). Default is "Consumption".
err	the name of the error column in the output. Default is ".err".
tol	the maximum amount by which Supply and Consumption can be out of balance

Details

Be sure to group .ieatidydata prior to calling this function, as shown in the example.

If energy is in balance for every group, a data frame with additional column err is returned. If energy balance is not observed for one or more of the groups, a warning is emitted.

Value

a data frame containing with grouping variables and an additional column whose name is the value of err. The err column should be 0.

Examples

library(dplyr)
UKEnergy2000tidy %>%
  filter(LastStage %in% c("Final", "Useful")) %>%
  group_by(Country, Year, EnergyType, LastStage) %>%
  verify_IEATable_energy_balance(energy = IEATools::iea_cols$e_dot)

MatthewHeun/Recca documentation built on Dec. 10, 2024, 10 p.m.