cyclic_basis: Cyclic Basis Function

View source: R/cyclic.R

cyclic_basisR Documentation

Cyclic Basis Function

Description

The cyclic basis function for modelling seasonal effects

Usage

cyclic_basis(var, order = 3, frequency)

Arguments

var

a numeric_var object

order

the order of the basis function

frequency

frequency

Details

cyclic_basis returns a set of sin and cosine functions for modelling seasonal effects, see \bibcitetbasefun::Held_Paul_2012, Section 2.2.

For any choice of coefficients, the function returns the same value when evaluated at multiples of frequency.

References

\bibshow

*

Examples


  ### set-up basis
  cb <- cyclic_basis(numeric_var("x"), order = 3, frequency = 2 * pi)

  ### generate data + coefficients
  x <- data.frame(x = c(0, pi, 2 * pi))

  ### f(0) = f(2 * pi)
  cb(x) 

basefun documentation built on March 7, 2026, 1:07 a.m.