is_periodic_dates: Check date series is periodic or not

Description Usage Arguments Details Value See Also

View source: R/utils-dates.R

Description

Check whether date series is regular/irregular periodic or not.

Usage

1
2
3
4
5
is_periodic_dates(
  dates_series,
  freq_rule = c("day", "month", "quarter", "year"),
  regular = FALSE
)

Arguments

dates_series

A vector of dates/timestamps.

freq_rule

Frequency rule of period to test, e.g. "day", "month", "quarter", "year", default "Day".

regular

Whether to test date series as a regular periodic series or not. Since irregular test is looser than regular test, irregular test on regular series will always return true. Default is FALSE, which means we will use looser test(irregular).

Details

Periodic dates includes two kinds:

Value

return TRUE if dates is periodic, otherwise FALSE.

See Also

Other utils_dates: as_period_date(), guess_dates_period()


chriszheng2016/zstmodelr documentation built on June 13, 2021, 8:59 p.m.