Extract frequencies for common seasonal periods

Source: R/frequency.R

Extract frequencies for common seasonal periods

common_periods(x)

# Default S3 method
common_periods(x)

# S3 method for class 'tbl_ts'
common_periods(x)

# S3 method for class 'interval'
common_periods(x)

get_frequencies(period, ...)

# S3 method for class 'numeric'
get_frequencies(period, ...)

# S3 method for class '`NULL`'
get_frequencies(period, data, ..., .auto = c("smallest", "largest", "all"))

# S3 method for class 'character'
get_frequencies(period, data, ...)

# S3 method for class 'Period'
get_frequencies(period, data, ...)

Arguments

x

An object containing temporal data (such as a tsibble, interval, datetime and others.)

period

Specification of the time-series period

...

Other arguments to be passed on to methods

data

A tsibble

.auto

The method used to automatically select the appropriate seasonal periods

Value

A named vector of frequencies appropriate for the provided data.

Examples

common_periods(tsibble::pedestrian)
#> year week  day 
#> 8766  168   24