tsdecompose: Model Decomposition

tsdecompose.tsissm.estimateR Documentation

Model Decomposition

Description

Decomposes the estimated model or prediction into its component parts (states).

Usage

## S3 method for class 'tsissm.estimate'
tsdecompose(object, simplify = FALSE, ...)

## S3 method for class 'tsissm.predict'
tsdecompose(object, simplify = FALSE, ...)

Arguments

object

an object of class “tsissm.estimate” or “tsissm.predict”

simplify

simplification of the returned states aggregates the level and slope (if present) into a Trend component, all Seasonal components, all ARMA components and the error terms into an Irregular component. This may be useful when bagging is carried out (assuming equal lambda in the box-cox transform or the logit transform is used). This also simplifies the ability to created custom overrides of the Trend and rebuilt the predictive distribution.

...

not currently used.

Details

The 1-step ahead prediction is given by the following equation:

y_{t} = x_{t-1} w + \varespsilon_{t}

Because the decomposition pre lags the states so that the seed state is aligned with the error term, then summing the state distribution of each component with the returned error distribution will ensure that the exact same predicted value matched to the correct date is returned.

Value

For the estimated object, returns an xts matrix of the state components (including Irregular term). For the predicted object, a list with the simulated state components of class “tsmodel.predict” which includes the predictive distribution and original (estimated) series components.


tsmodels/tsissm documentation built on June 22, 2022, 6:57 a.m.