calculate_indicator: Calculate time series KPI.

In biggproject/biggr: biggr

Calculate time series KPI.

Description

This function calculates a large list of energy-related KPIs considering a set predicted and real energy measurements. It only accounts for KPI that can be time-aggregable, so input and output data are time series.

Usage

calculate_indicator(
  data,
  indicator,
  consumptionColumn,
  baselineConsumptionColumn,
  energyPriceColumn,
  carbonEmissionsColumn,
  buildingGrossFloorArea,
  heatingDegreeDays18Column,
  coolingDegreeDays21Column
)

Arguments

data	<data.frame> that contains all resultant time series.
indicator	<string> defining the KPI to calculate. Possible values: EnergyUse, EnergyUseIntensity, EnergyUseSavings, EnergyUseSavingsRelative, EnergyUseSavingsIntensity, EnergyCost, EnergyCostIntensity, EnergyCostSavings, EnergyCostSavingsRelative, EnergyCostSavingsIntensity, EnergyEmissions, EnergyEmissionsIntensity, EnergyEmissionsSavings, EnergyEmissionsSavingsRelative, EnergyEmissionsSavingsIntensity, HeatingDegreeDays, CoolingDegreeDays
consumptionColumn	<string> defining the energy consumption column name in data.
baselineConsumptionColumn	<string> defining the counterfactual energy consumption column name in data.
energyPriceColumn	<string> defining the column in data related with the price of energy consumption.
carbonEmissionsColumn	<string> defining the column in data related with the CO2 emissions factor of energy consumption.
buildingGrossFloorArea	<float> defining the gross floor area of the building.
heatingDegreeDays18Column	<string> defining the column in data related with HDD with 18º as base temperature.
coolingDegreeDays21Column	<string> defining the column in data related with CDD with 21º as base temperature.

Value

<data.frame> with a column 'ind' specifying the indicator time series and an optional 'weights' column specifying the weights that should be considered when time-aggregate the results.

biggproject/biggr documentation built on Oct. 2, 2024, 11:13 p.m.