| mapaest {MAPA} | R Documentation |
MAPA Estimation
Description
The following function estimates MAPA and saves all fitted model.
Usage
mapaest(y, ppy, minimumAL = 1, maximumAL = ppy, paral = c(0,1,2),
display = c(0,1), outplot = c(0,1), model = "ZZZ", type=c("ets","es"),
xreg = NULL, pr.comp = 0, ...)
Arguments
y |
In sample observations of a time series (vector). |
ppy |
Periods in a season of the time series at the sampled frequency. If insample is a ts object then this is taken from its frequency, unless overriden. |
minimumAL |
Lowest aggregation level to use. Default = 1, maximumAL>1. |
maximumAL |
Highest aggregation level to use. Default = ppy. |
paral |
Use parallel processing. 0 = no; 1 = yes (requires initialised cluster); 2 = yes and initialise cluster. Default is 0. |
display |
Display calculation progress in console. 0 = no; 1 = yes. Default is 0. |
outplot |
Provide output plot. 0 = no; 1 = yes. Default is 0. |
model |
Allow only that type of ETS at each aggregation level. This follows similar coding to the ets function. The first letter refers to the error type ("A", "M" or "Z"); the second letter refers to the trend type ("N","A","Ad","M","Md", "Z", "X" or "Y"); and the third letter refers to the season type ("N","A","M", "Z", "X" or "Y"). The letters mean: "N"=none, "A"=additive, "M"=multiplicative, "Z"=automatically selected, "X"=automatically select between none and additive and "Y"=automatically select between none and multiplicative. A "d" for trend implies damped. "X" and "Y" supported only by type=="es". If used with type=="ets" a warning will be given and they will default to "Z". By default model="ZZZ". If due to sample limitation ETS cannot be calculated at an aggregation level for the selected model, then no estimation is done for that specific level. For aggregation levels that seasonality becomes 1 then a non-seasonal model is estimated. |
type |
What type of exponential smoothing implementation to use. "es" = use from the smooth package; "ets" = use from the forecast package. Default is "es" |
xreg |
Vector or matrix of exogenous variables to be included in the MAPA. If matrix then rows are observations and columns are variables. Must be at least as long as in-sample. Additional observations are unused. Note that including xreg will force type="es". |
pr.comp |
MAPAx can use principal component analysis to preprocess xreg. When comp is -1 then the number of retained components is chosen automatically. When comp=0 then no pre-processing is performed and the original xreg is used. Any other value represents the number of principal components retained. |
... |
Pass additional arguments to es or ets. |
Value
mapafit |
Estimated MAPA model structure. |
Author(s)
Nikolaos Kourentzes, nikolaos@kourentzes.com; Fotios Petropoulos.
References
Kourentzes N., Petropoulos F., Trapero J.R. (2014) Improving forecasting by estimating time series structural components across multiple frequencies. International Journal of Forecasting, 30(2), 291–302.
Kourentzes N., Petropoulos F. (2015) Forecasting with multivariate temporal aggregation: The case of promotional modelling. International Journal of Production Economics.
You can find more information about MAPA at Nikos' blog.
See Also
Examples
mapafit <- mapaest(admissions)