get_KPI_timeseries: Get one Key Performance Indicator (KPI) time series from a...

View source: R/harmonised-reading.R

get_KPI_timeseriesR Documentation

Get one Key Performance Indicator (KPI) time series from a certain building.

Description

This function use the harmonised data to extract a specific KPI time series of a certain building.

Usage

get_KPI_timeseries(
  buildingsRdf,
  timeseriesObject,
  buildingSubject,
  name,
  fromModel,
  frequency
)

Arguments

buildingsRdf

<rdf> containing all metadata about buildings. It must be harmonised to BIGG Ontology.

timeseriesObject

<array> of strings with paths to JSON files containing time series, or <list> of time series. It must be harmonised to BIGG Ontology.

buildingSubject

<uri> of the building subject in buildingsRdf.

name

<string> defining the indicator name to be retrieved.

fromModel

<boolean> defining if the time series should be real (FALSE), or estimated (TRUE)

frequency

<string> defining the frequency to be retrieved. It must follow ISO 8601 format representing the time step. Examples: 'P1D' (One day), P1Y' (One year), 'P1M' (One month)

Value

<data.frame> with columns 'time' and 'value'.


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