generate_longitudinal_benchmarking_indicators: Generate the harmonised longitudinal benchmarking results

In biggproject/biggr: biggr

Generate the harmonised longitudinal benchmarking results

Description

Generate the results in harmonised format to BIGG ontology for the energy consumption benchmarking of buildings. In this case, the focus is to generate the results for the longitudinal benchmarking, so input data must be related with one single building.

Usage

generate_longitudinal_benchmarking_indicators(
  data,
  indicators,
  measuredProperty,
  measuredPropertyComponent,
  frequencies,
  buildingId,
  buildingSubject,
  timeColumn,
  localTimeZone,
  consumptionColumn,
  indicatorsUnitsSubjects,
  baselineConsumptionColumn = NULL,
  buildingGrossFloorArea = NULL,
  outdoorTemperatureColumn = NULL,
  heatingDegreeDays18Column = NULL,
  coolingDegreeDays21Column = NULL,
  carbonEmissionsColumn = NULL,
  energyPriceColumn = NULL,
  modelName = NULL,
  modelId = NULL,
  modelLocation = NULL,
  modelStorageInfrastructureSubject = NULL,
  modelTypeSubject = NULL,
  modelBaselineYear = NULL,
  estimateWhenAggregate = T,
  minRatioToTimeAggregateIndicators = 0.75,
  prevResults = NULL
)

Arguments

data	<data.frame> that contains all resultant time series.
indicators	<array> of strings defining the KPIs to calculate. Possible values: EnergyUse, EnergyUseIntensity, EnergyUseSavings, EnergyUseSavingsRelative, EnergyUseSavingsIntensity, EnergyCost, EnergyCostIntensity, EnergyCostSavings, EnergyCostSavingsRelative, EnergyCostSavingsIntensity, EnergyEmissions, EnergyEmissionsIntensity, EnergyEmissionsSavings, EnergyEmissionsSavingsRelative, EnergyEmissionsSavingsIntensity, HeatingDegreeDays, CoolingDegreeDays
measuredProperty	<uri> defining the energy consumption measured property. (E.g.: http://bigg-project.eu/ontology#EnergyConsumptionGridElectricity)
measuredPropertyComponent	<uri> defining the energy consumption component name. (E.g.: "http://bigg-project.eu/ontology#Heating").
frequencies	<array> of strings defining the frequencies used to resample the results. They must follow ISO 8601 format representing the time step. Examples: 'P1D' (One day), 'P1Y' (One year), 'P1M' (One month), 'P1DT12H' (One day and a half)...
buildingId	<string> building unique identifier.
buildingSubject	<uri> building unique URI.
timeColumn	<string> of the time column name.
localTimeZone	<string> specifying the local time zone related to the building in analysis. The format of this time zones are defined by the IANA Time Zone Database (https://www.iana.org/time-zones).
consumptionColumn	<string> defining the energy consumption column name in data.
indicatorsUnitsSubjects	named <array> of URIs containing the units for each indicator.
baselineConsumptionColumn	<string> defining the counterfactual energy consumption column name in data. By default it is not considered.
buildingGrossFloorArea	<float> defining the gross floor area of the building. By default it is not considered.
outdoorTemperatureColumn	<string> defining the column in data related to outdoor temperature. By default it is not considered.
heatingDegreeDays18Column	<string> defining the column in data related with HDD with 18º as base temperature. By default it is not considered.
coolingDegreeDays21Column	<string> defining the column in data related with CDD with 21º as base temperature. By default it is not considered.
carbonEmissionsColumn	<string> defining the column in data related with the CO2 emissions factor of energy consumption. By default it is not considered.
energyPriceColumn	<string> defining the column in data related with the price of energy consumption. By default it is not considered.
modelName	<string> Name of the model used to predict the consumption. By default results are not based by any model.
modelId	<string> Identifier of the model used to predict the consumption. By default results are not based by any model.
modelLocation	<string> containing the model path in the model storage infrastructure. By default results are not based by any model.
modelStorageInfrastructureSubject	<uri> of the model infrastructure type. By default results are not based by any model.
modelTypeSubject	<uri> of the model type depending on the data training strategy (Dynamic or Baseline). By default results are not based by any model.
modelBaselineYear	<array> of integers containing the baseline years considered in model training. Only useful when the model type is baseline. By default results are not based by any model.
estimateWhenAggregate	<boolean> defining if a linear estimation should be made when gaps are found in the time-aggregation of the results. By default, the estimation is done. #' @param minRatioToTimeAggregateIndicators <float> [0-1] defining the minimum ratio of data (real vs. theoretical) that should be considered for time-aggregation operations in the results. By default, 75 timestep is not considered in the results. This will avoid yearly and monthly results with very rough results.
prevResults	<list> with the previous results of this function. By default, no previous results are considered.

Value

<list> containing a knowledge graph with all resultant metadata and time series objects, that later can be transformed to TTL and JSON files.

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