Add Calendar Features — feat_calendar

Add calendar-based features such as day of week, month, week of year, etc. These features are commonly useful for capturing seasonal patterns in time series.

Usage

feat_calendar_dt(
  df,
  date,
  dow = TRUE,
  woy = FALSE,
  month = TRUE,
  eom = TRUE,
  dom = FALSE,
  hod = FALSE,
  moh = FALSE
)

Arguments

df: A data frame containing time series data
date: Symbol or character naming the date column (Date or POSIXct class)
dow: Logical, add day of week as ordered factor (1=Monday, 7=Sunday)
woy: Logical, add week of year (1-53)
month: Logical, add month as factor (01-12)
eom: Logical, add end-of-month indicator (0 or 1)
dom: Logical, add day of month (1-31)
hod: Logical, add hour of day (0-23) - requires POSIXct
moh: Logical, add minute of hour (0-59) - requires POSIXct

Value

Data frame with calendar features added

Examples

if (FALSE) { # \dontrun{
# Add default calendar features (dow, month, eom)
df_cal <- feat_calendar_dt(df, date = date)

# Add all calendar features
df_cal <- feat_calendar_dt(df, date = date,
                            dow = TRUE, woy = TRUE, month = TRUE,
                            eom = TRUE, dom = TRUE)

# Add sub-daily features for POSIXct data
df_cal <- feat_calendar_dt(df, date = datetime, hod = TRUE, moh = TRUE)
} # }