calendar_components: Time decomposition

calendar_componentsR Documentation

Time decomposition

Description

Decompose the time in date, day of the year, day of the week, day of the weekend, working day, non-working day, season, month, hour, minute, ...

Usage

calendar_components(data, localTimeZone = NULL, holidays = c(), inplace = T)

Arguments

data

<data.frame> containing the series to transform. The time zone of the datetimes must be UTC. The other variables describing the series are directly bypassed to the output.

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). This argument is optional, by default no transformation to local time zone is done.

holidays

<array> of dates classified as holidays

inplace

<boolean> indicating if the output should be the original data argument, plus the transformed objects -True- , or only the transformed series -False.

Value

<data.frame> containing the same initial information of data input argument, plus the calendar components as new columns.


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