This vignette explains how to use functions in ‘smooth’ package, what they produce, what each field in outputs and what returned values mean. Underlying statistical models are not discussed here, but if you want to know more about them, then there is a document “Statistical models underlying functions of ‘smooth’ package for R”.
The package includes the following functions:
xregExpander()
– function that creates lags and leads of the provided exogenous variables (either vector or matrix). This thing returns the matrix.stepwise()
– the function that implements stepwise based on information criteria and partial correlations. Easier to use and works faster than step()
from ``stats’’ package.This funcions (except for the last one) return object of class ``smooth’’, which uses several methods.
smooth
There are several functions that can be used together with es()
, ces()
, ssarima()
and ges()
functions. So when a model is saved to some object ourModel
, these function will do some things. Here’s the list of all the available methods with some explanations:
summary(ourModel)
– function prints brief output with explanation of what was fitted, with what parameters and errors;fitted(ourModel)
– fitted values;forecast(ourModel)
– point and interval forecasts. This is needed for compatibility with Rob Hyndman’s “forecast” package. forecast(ourModel)
returns object of class forecastSmooth
;residuals(ourModel)
– residuals of constructed model;AIC(ourModel)
, BIC(ourModel)
and AICc(ourModel)
– information criteria of the constructed model. AICc()
function is not a standard stats'' function and is introduced by
smooth’’;plot(ourModel)
– plots states of constructed model. If number of states is higher than 10, then several graphs are produced;simulate(ourModel)
– produces data simulated from provided model. Currently only available for ETS via simulate(es(...))
;summary(forecast(ourModel))
– prints point and interval forecasts;plot(forecast(ourModel))
– produces graph with actuals, forecast, fitted and intervals using graphmaker()
function.logLik(ourModel)
– returns log-likelihood of the model;nobs(ourModel)
– returns number of observations in-sample we had;nParam(ourModel)
– number of estimated parameters;pointLik(ourModel)
– likelihood values for each separate observation;sigma(ourModel)
– variance of the residuals of the model;lags(ourModel)
– lags of the model (used with ssarima()
and ges()
);orders(ourModel)
– orders of the model (can be used with ssarima()
and ges()
);modelType(ourModel)
– returns the type of the model. Returns something like “MMM” for ETS(MMM). Can be used with es()
, ces()
and ets()
.coef(ourModel)
– returns the vector of all the estimated coefficients of the model.formula(ourModel)
– returns the formula for the measurement equation. This is just for the information and general understanding what we work with.