degree_days: Degree days with time aggregation

View source: R/transformation.R

degree_daysR Documentation

Degree days with time aggregation

Description

Calculate the degree-days with a desired output frequency and considering cooling or heating mode.

Usage

degree_days(
  data,
  temperatureFeature,
  localTimeZone,
  baseTemperature,
  mode = "heating",
  outputFrequency = "P1D",
  hysteresisBaseTemperature = 2,
  outputFeaturesName = "HDD",
  fixedOutputFeaturesName = F
)

Arguments

data

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

temperatureFeature

<string> giving the column name of the outdoor temperature feature.

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.

baseTemperature

<float> describing the Balance Point Temperature (BPT) used in the calculation. Below BPT in heating mode, heat would be required by the building. The contrary in the case of cooling, over BPT in cooling mode

mode

<string> describing the calculation mode, which could be "cooling" or "heating". By default, "heating" is configured.

outputFrequency

<string> The frequency used to resample the daily degree days. It must be a string in ISO 8601 format representing the time step. Examples: 'P1D' (One day), 'P1Y' (One year), 'P1M' (One month)...

outputFeaturesName

<string> giving the column name used as output of the degreedays result. By default, "HDD" is configured

fixedOutputFeaturesName

<boolean> enable fixed column name used as output of the degreedays results. Otherwise baseTemperature is added as suffix in the output column name

Value

<data.frame> in the outputTimeStep of the heating or cooling degree days.


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