get_device_aggregators: Get the metadata and time series from a filtered set of...

View source: R/harmonised-reading.R

get_device_aggregatorsR Documentation

Get the metadata and time series from a filtered set of device aggregators

Description

This function get the metadata and time series from a filtered set of device aggregators available in a BIGG-harmonised dataset.

Usage

get_device_aggregators(
  buildingsRdf,
  timeseriesObject = NULL,
  allowedBuildingSubjects = NULL,
  allowedMeasuredProperties = NULL,
  useEstimatedValues = F,
  ratioCorrection = T,
  containsEEMs = F,
  alignGreaterThanHourlyFrequencyToYearly = F,
  transformToAggregatableMeasuredProperty = F,
  aggregatableMeasuredPropertyName = NULL,
  measuredPropertiesToAggregate = 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.

allowedBuildingSubjects

<array> of URI(s) containing the allowed building subject(s).

allowedMeasuredProperties

<array> of string(s) containing the allowed measured property(ies).

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.

containsEEMs

<boolean> to filter only those buildings that contain one or more EEM.

alignGreaterThanHourlyFrequencyToYearly

<boolean> to force time alignment to P1Y frequency if original alignment frequency is greater to PT1H.

Value

<list> of time series and metadata related with all device aggregators.


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