compute_device_aggregator_formula: Compute the specified formula of a device aggregator

In biggproject/biggr: biggr

Compute the specified formula of a device aggregator

Description

This function obtains all the time series related with a device aggregator, aggregates them according to the device aggregator metadata and obtains a single resultant time series.

Usage

compute_device_aggregator_formula(
  buildingsRdf,
  timeseriesObject,
  buildingSubject,
  formula,
  outputFrequency,
  aggFunctions,
  useEstimatedValues,
  ratioCorrection = F,
  minRatioCorrection = 0.7,
  transformToAggregatableMeasuredProperty = F,
  aggregatableMeasuredPropertyName = NULL,
  defaultFactorsByMeasuredProperty = NULL
)

Arguments

buildingsRdf	<rdf> containing the information of a set of buildings.
timeseriesObject	<string> path of JSON files, or <list> of time series.
buildingSubject	<uri> containing the building subject.
formula	<string> describing the formula for the device aggregator. It consist on a sequence of arithmetical operations over one (or multiple) sensor identifier(s). The sensor identifiers must be written between prefix '<mi>' and suffix </mi>. On contrary, the operators are described between prefix <mo> and suffix </mo>. Example of the sum of two sensors (let's identify them as 'ID1' and 'ID2'): '<mi>ID1</mi><mo>+</mo><mi>ID2</mi>'
outputFrequency	<string> defining the frequency selected as output. It must follow ISO 8601 format representing the time step.
aggFunctions	<string> describing the possible aggregation functions of the resultant time series. Possible values: 'SUM', 'AVG', 'HDD', 'CDD'.
useEstimatedValues	<boolean> describing if the estimated values of time series should be taken into account.
ratioCorrection	<boolean> describing whether a ratio correction should be done, or not. Important to set to TRUE when time series contain gaps.

Value

<data.frame> containing the resultant time series.

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