smooth (version 3.1.4)

gum: Generalised Univariate Model


Function constructs Generalised Univariate Model, estimating matrices F, w, vector g and initial parameters.


gum(y, orders = c(1, 1), lags = c(1, frequency(y)), type = c("additive",
  "multiplicative"), persistence = NULL, transition = NULL,
  measurement = NULL, initial = c("optimal", "backcasting"),
  ic = c("AICc", "AIC", "BIC", "BICc"), loss = c("likelihood", "MSE",
  "MAE", "HAM", "MSEh", "TMSE", "GTMSE", "MSCE"), h = 10, holdout = FALSE,
  cumulative = FALSE, interval = c("none", "parametric", "likelihood",
  "semiparametric", "nonparametric"), level = 0.95,
  bounds = c("restricted", "admissible", "none"), silent = c("all",
  "graph", "legend", "output", "none"), xreg = NULL, xregDo = c("use",
  "select"), initialX = NULL, ...)




Vector or ts object, containing data needed to be forecasted.


Order of the model. Specified as vector of number of states with different lags. For example, orders=c(1,1) means that there are two states: one of the first lag type, the second of the second type.


Defines lags for the corresponding orders. If, for example, orders=c(1,1) and lags are defined as lags=c(1,12), then the model will have two states: the first will have lag 1 and the second will have lag 12. The length of lags must correspond to the length of orders.


Type of model. Can either be "A" - additive - or "M" - multiplicative. The latter means that the GUM is fitted on log-transformed data.


Persistence vector \(g\), containing smoothing parameters. If NULL, then estimated.


Transition matrix \(F\). Can be provided as a vector. Matrix will be formed using the default matrix(transition,nc,nc), where nc is the number of components in state vector. If NULL, then estimated.


Measurement vector \(w\). If NULL, then estimated.


Can be either character or a vector of initial states. If it is character, then it can be "optimal", meaning that the initial states are optimised, or "backcasting", meaning that the initials are produced using backcasting procedure.


The information criterion used in the model selection procedure.


The type of Loss Function used in optimization. loss can be: likelihood (assuming Normal distribution of error term), MSE (Mean Squared Error), MAE (Mean Absolute Error), HAM (Half Absolute Moment), TMSE - Trace Mean Squared Error, GTMSE - Geometric Trace Mean Squared Error, MSEh - optimisation using only h-steps ahead error, MSCE - Mean Squared Cumulative Error. If loss!="MSE", then likelihood and model selection is done based on equivalent MSE. Model selection in this cases becomes not optimal.

There are also available analytical approximations for multistep functions: aMSEh, aTMSE and aGTMSE. These can be useful in cases of small samples.

Finally, just for fun the absolute and half analogues of multistep estimators are available: MAEh, TMAE, GTMAE, MACE, TMAE, HAMh, THAM, GTHAM, CHAM.


Length of forecasting horizon.


If TRUE, holdout sample of size h is taken from the end of the data.


If TRUE, then the cumulative forecast and prediction interval are produced instead of the normal ones. This is useful for inventory control systems.


Type of interval to construct. This can be:

  • "none", aka "n" - do not produce prediction interval.

  • "parametric", "p" - use state-space structure of ETS. In case of mixed models this is done using simulations, which may take longer time than for the pure additive and pure multiplicative models. This type of interval relies on unbiased estimate of in-sample error variance, which divides the sume of squared errors by T-k rather than just T.

  • "likelihood", "l" - these are the same as "p", but relies on the biased estimate of variance from the likelihood (division by T, not by T-k).

  • "semiparametric", "sp" - interval based on covariance matrix of 1 to h steps ahead errors and assumption of normal / log-normal distribution (depending on error type).

  • "nonparametric", "np" - interval based on values from a quantile regression on error matrix (see Taylor and Bunn, 1999). The model used in this process is e[j] = a j^b, where j=1,..,h.

The parameter also accepts TRUE and FALSE. The former means that parametric interval are constructed, while the latter is equivalent to none. If the forecasts of the models were combined, then the interval are combined quantile-wise (Lichtendahl et al., 2013).


Confidence level. Defines width of prediction interval.


What type of bounds to use in the model estimation. The first letter can be used instead of the whole word.


If silent="none", then nothing is silent, everything is printed out and drawn. silent="all" means that nothing is produced or drawn (except for warnings). In case of silent="graph", no graph is produced. If silent="legend", then legend of the graph is skipped. And finally silent="output" means that nothing is printed out in the console, but the graph is produced. silent also accepts TRUE and FALSE. In this case silent=TRUE is equivalent to silent="all", while silent=FALSE is equivalent to silent="none". The parameter also accepts first letter of words ("n", "a", "g", "l", "o").


The vector (either numeric or time series) or the matrix (or data.frame) of exogenous variables that should be included in the model. If matrix included than columns should contain variables and rows - observations. Note that xreg should have number of observations equal either to in-sample or to the whole series. If the number of observations in xreg is equal to in-sample, then values for the holdout sample are produced using es function.


The variable defines what to do with the provided xreg: "use" means that all of the data should be used, while "select" means that a selection using ic should be done. "combine" will be available at some point in future...


The vector of initial parameters for exogenous variables. Ignored if xreg is NULL.


Other non-documented parameters. For example parameter model can accept a previously estimated GUM model and use all its parameters. FI=TRUE will make the function produce Fisher Information matrix, which then can be used to calculated variances of parameters of the model. You can also pass two parameters to the optimiser: 1. maxeval - maximum number of evaluations to carry on; 2. xtol_rel - the precision of the optimiser. The default values used in es() are maxeval=5000 and xtol_rel=1e-8. You can read more about these parameters in the documentation of nloptr function.


Object of class "smooth" is returned. It contains:

  • model - name of the estimated model.

  • timeElapsed - time elapsed for the construction of the model.

  • states - matrix of fuzzy components of GUM, where rows correspond to time and cols to states.

  • initialType - Type of the initial values used.

  • initial - initial values of state vector (extracted from states).

  • nParam - table with the number of estimated / provided parameters. If a previous model was reused, then its initials are reused and the number of provided parameters will take this into account.

  • measurement - matrix w.

  • transition - matrix F.

  • persistence - persistence vector. This is the place, where smoothing parameters live.

  • fitted - fitted values.

  • forecast - point forecast.

  • lower - lower bound of prediction interval. When interval="none" then NA is returned.

  • upper - higher bound of prediction interval. When interval="none" then NA is returned.

  • residuals - the residuals of the estimated model.

  • errors - matrix of 1 to h steps ahead errors.

  • s2 - variance of the residuals (taking degrees of freedom into account).

  • interval - type of interval asked by user.

  • level - confidence level for interval.

  • cumulative - whether the produced forecast was cumulative or not.

  • y - original data.

  • holdout - holdout part of the original data.

  • xreg - provided vector or matrix of exogenous variables. If xregDo="s", then this value will contain only selected exogenous variables.

  • initialX - initial values for parameters of exogenous variables.

  • ICs - values of information criteria of the model. Includes AIC, AICc, BIC and BICc.

  • logLik - log-likelihood of the function.

  • lossValue - Cost function value.

  • loss - Type of loss function used in the estimation.

  • FI - Fisher Information. Equal to NULL if FI=FALSE or when FI variable is not provided at all.

  • accuracy - vector of accuracy measures for the holdout sample. In case of non-intermittent data includes: MPE, MAPE, SMAPE, MASE, sMAE, RelMAE, sMSE and Bias coefficient (based on complex numbers). In case of intermittent data the set of errors will be: sMSE, sPIS, sCE (scaled cumulative error) and Bias coefficient. This is available only when holdout=TRUE.

  • B - the vector of all the estimated parameters.


The function estimates the Single Source of Error state space model of the following type:

$$y_{t} = o_{t} (w' v_{t-l} + x_t a_{t-1} + \epsilon_{t})$$

$$v_{t} = F v_{t-l} + g \epsilon_{t}$$

$$a_{t} = F_{X} a_{t-1} + g_{X} \epsilon_{t} / x_{t}$$

Where \(o_{t}\) is the Bernoulli distributed random variable (in case of normal data equal to 1), \(v_{t}\) is the state vector (defined using orders) and \(l\) is the vector of lags, \(x_t\) is the vector of exogenous parameters. \(w\) is the measurement vector, \(F\) is the transition matrix, \(g\) is the persistence vector, \(a_t\) is the vector of parameters for exogenous variables, \(F_{X}\) is the transitionX matrix and \(g_{X}\) is the persistenceX matrix. Finally, \(\epsilon_{t}\) is the error term.

For some more information about the model and its implementation, see the vignette: vignette("gum","smooth")


  • Svetunkov I. (2015 - Inf) "smooth" package for R - series of posts about the underlying models and how to use them:

  • Svetunkov I. (2017). Statistical models underlying functions of 'smooth' package for R. Working Paper of Department of Management Science, Lancaster University 2017:1, 1-52.

  • Taylor, J.W. and Bunn, D.W. (1999) A Quantile Regression Approach to Generating Prediction Intervals. Management Science, Vol 45, No 2, pp 225-237.

  • Lichtendahl Kenneth C., Jr., Grushka-Cockayne Yael, Winkler Robert L., (2013) Is It Better to Average Probabilities or Quantiles? Management Science 59(7):1594-1611. DOI: 10.1287/mnsc.1120.1667

See Also

adam, es, ces,


Run this code
# Something simple:

# A more complicated model with seasonality
# }
ourModel <- gum(rnorm(118,100,3),orders=c(2,1),lags=c(1,4),h=18,holdout=TRUE)
# }
# Redo previous model on a new data and produce prediction interval
# }
# }
# Produce something crazy with optimal initials (not recommended)
# }
# }
# Simpler model estiamted using trace forecast error loss function and its analytical analogue
# }
# }
# Introduce exogenous variables
# }
# }
# Or select the most appropriate one
# }

# }
# }

Run the code above in your browser using DataCamp Workspace