oes {smooth} | R Documentation |
Occurrence ETS model
Description
Function returns the occurrence part of iETS model with the specified probability update and model types.
Usage
oes(y, model = "MNN", persistence = NULL, initial = "o",
initialSeason = NULL, phi = NULL, occurrence = c("fixed", "general",
"odds-ratio", "inverse-odds-ratio", "direct", "auto", "none"),
ic = c("AICc", "AIC", "BIC", "BICc"), h = 10, holdout = FALSE,
bounds = c("usual", "admissible", "none"), silent = c("all", "graph",
"legend", "output", "none"), xreg = NULL, regressors = c("use",
"select"), initialX = NULL, ...)
Arguments
y |
Either numeric vector or time series vector. |
model |
The type of ETS model used for the estimation. Normally this should
be |
persistence |
Persistence vector |
initial |
Can be either character or a vector of initial states. If it
is character, then it can be |
initialSeason |
The vector of the initial seasonal components. If |
phi |
The value of the dampening parameter. Used only for damped-trend models. |
occurrence |
The type of model used in probability estimation. Can be
|
ic |
The information criteria to use in case of model selection. |
h |
The forecast horizon. |
holdout |
If |
bounds |
What type of bounds to use in the model estimation. The first letter can be used instead of the whole word. |
silent |
If |
xreg |
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 |
regressors |
The variable defines what to do with the provided xreg:
|
initialX |
The vector of initial parameters for exogenous variables.
Ignored if |
... |
The parameters passed to the optimiser, such as |
Details
The function estimates probability of demand occurrence, using the selected ETS state space models.
For the details about the model and its implementation, see the respective
vignette: vignette("oes","smooth")
Value
The object of class "occurrence" is returned. It contains following list of values:
-
model
- the type of the estimated ETS model; -
timeElapsed
- the time elapsed for the construction of the model; -
fitted
- the fitted values for the probability; -
fittedModel
- the fitted values of the underlying ETS model, where applicable (only for occurrence=c("o","i","d")); -
forecast
- the forecast of the probability forh
observations ahead; -
forecastModel
- the forecast of the underlying ETS model, where applicable (only for occurrence=c("o","i","d")); -
lower
- the lower bound of the interval ifinterval!="none"
; -
upper
- the upper bound of the interval ifinterval!="none"
; -
lowerModel
- the lower bound of the interval of the underlying ETS model ifinterval!="none"
; -
upperModel
- the upper bound of the interval of the underlying ETS model ifinterval!="none"
; -
states
- the values of the state vector; -
logLik
- the log-likelihood value of the model; -
nParam
- the number of parameters in the model (the matrix is returned); -
residuals
- the residuals of the model; -
y
- actual values of occurrence (zeros and ones). -
persistence
- the vector of smoothing parameters; -
phi
- the value of the damped trend parameter; -
initial
- initial values of the state vector; -
initialSeason
- the matrix of initials seasonal states; -
occurrence
- the type of the occurrence model; -
updateX
- boolean, defining, if the states of exogenous variables were estimated as well. -
initialX
- initial values for parameters of exogenous variables. -
persistenceX
- persistence vector g for exogenous variables. -
transitionX
- transition matrix F for exogenous variables. -
accuracy
- The error measures for the forecast (in case ofholdout=TRUE
). -
B
- the vector of all the estimated parameters (in case of "odds-ratio", "inverse-odds-ratio" and "direct" models).
Author(s)
Ivan Svetunkov, ivan@svetunkov.ru
References
Svetunkov Ivan and Boylan John E. (2017). Multiplicative State-Space Models for Intermittent Time Series. Working Paper of Department of Management Science, Lancaster University, 2017:4 , 1-43.
Teunter R., Syntetos A., Babai Z. (2011). Intermittent demand: Linking forecasting to inventory obsolescence. European Journal of Operational Research, 214, 606-615.
Croston, J. (1972) Forecasting and stock control for intermittent demands. Operational Research Quarterly, 23(3), 289-303.
Syntetos, A., Boylan J. (2005) The accuracy of intermittent demand estimates. International Journal of Forecasting, 21(2), 303-314.
See Also
Examples
y <- rpois(100,0.1)
oes(y, occurrence="auto")
oes(y, occurrence="f")