make_default_season_state: Make a default seasonal state vector

View source: R/initialize_states.R

make_default_season_stateR Documentation

Make a default seasonal state vector

Description

Returns a neutral seasonal state vector. Neutral means a vector of 0s for an additive seasonal component, or a vector of 1s for a multiplicative seasonal component.

Usage

make_default_season_state(n, method)

Arguments

n

The target length of the state vector

method

Are we using an additive or a multiplicative seasonal state component?

Value

A numeric vector of length n; all zero if additive seasonal component, all one if multiplicative seasonal component

Examples

tulip:::make_default_season_state(n = 14, method = "additive")
tulip:::make_default_season_state(n = 63, method = "multiplicative")


timradtke/tulip documentation built on April 14, 2023, 10:21 p.m.