detect_holidays_in_tertiary_buildings: Detect holidays in consumption time series

detect_holidays_in_tertiary_buildingsR Documentation

Detect holidays in consumption time series

Description

The function detects holiday periods in buildings with highly seasonal patterns. An analysis of turnpoints in density function is performed to identify "over represented" low consumption dates. Additional post-processing is done in order to take care of additional constraints related to holidays period

Usage

detect_holidays_in_tertiary_buildings(
  data,
  consumptionColumn,
  timeColumn,
  plotDensity = T,
  ignoreDates = c(),
  tz = "UTC"
)

Arguments

data

<data.frame> Time series with potential anomalies in values

consumptionColumn

<string> Value column

timeColumn

<string> Time column

plotDensity

<boolean> Plot density function used to obtain holidays consumption threshold

ignoreDates

<list> Ignore list of dates in time series.

tz

<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).

Value

<array> of dates with classified as holidays.


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