AR1MA
The AR1MA class provides basic time-series analysis capabilities for Auto- Regressive 'AR' Integrated 'I' Moving-Average 'MA' models. In an AR1MA(p, q) model, p and q refer to the order of the Auto-Regressive and Moving-Average components of the model; d=1 refers to the order of differencing. Works by taking the first difference and delegating to the ARMA class. Also works for d=0 (no differencing).
Value parameters
- diffr
-
whether to take a first difference (defaults to true)
- hparam
-
the hyper-parameters
- tt
-
the time vector, if relevant (time index may suffice)
- y
-
the response vector (time-series data)
Attributes
- Graph
-
- Supertypes
-
trait Fittrait FitMtrait Correlogramtrait Forecastertrait Modelclass Objecttrait Matchableclass AnyShow all
Members list
Value members
Concrete methods
Produce a vector of size h, of 1 through h-steps ahead forecasts for the model. forecast the following time points: t+1, ..., t-1+h. Note, must create the yf matrix before calling the forecast method. Intended to work with rolling validation (analog of predict method)
Produce a vector of size h, of 1 through h-steps ahead forecasts for the model. forecast the following time points: t+1, ..., t-1+h. Note, must create the yf matrix before calling the forecast method. Intended to work with rolling validation (analog of predict method)
Value parameters
- h
-
the forecasting horizon, number of steps ahead to produce forecasts
- t
-
the time point from which to make forecasts
- y_
-
the actual values to use in making predictions
- yf
-
the forecasting matrix (time x horizons)
Attributes
Forecast values for all y_.dim time points and all horizons (1 through h-steps ahead). Record these in the yf matrix, where yf(t, k) = k-steps ahead forecast for y_t Note, column 0, yf(?, 0), is set to y (the actual time-series values). Forecast recursively down diagonals in the yf forecasting matrix. The top right and bottom left triangles in yf matrix are not forecastable.
Forecast values for all y_.dim time points and all horizons (1 through h-steps ahead). Record these in the yf matrix, where yf(t, k) = k-steps ahead forecast for y_t Note, column 0, yf(?, 0), is set to y (the actual time-series values). Forecast recursively down diagonals in the yf forecasting matrix. The top right and bottom left triangles in yf matrix are not forecastable.
Value parameters
- h
-
the maximum forecasting horizon, number of steps ahead to produce forecasts
- y_
-
the actual values to use in making forecasts
Attributes
Forecast values for all y_.dim time points at horizon h (h-steps ahead). Assign to forecasting matrix and return h-step ahead forecast.
Forecast values for all y_.dim time points at horizon h (h-steps ahead). Assign to forecasting matrix and return h-step ahead forecast.
Value parameters
- h
-
the forecasting horizon, number of steps ahead to produce forecasts
- y_
-
the actual values to use in making forecasts
- yf
-
the forecasting matrix (time x horizons)
Attributes
Forecast values for all y_.dim time points at horizon h (h-steps ahead). Assign to forecasting matrix and return h-step ahead forecast.
Forecast values for all y_.dim time points at horizon h (h-steps ahead). Assign to forecasting matrix and return h-step ahead forecast.
Value parameters
- h
-
the forecasting horizon, number of steps ahead to produce forecasts
- y_
-
the actual values to use in making forecasts
- yf
-
the forecasting matrix (time x horizons)
Attributes
Return the parameter vector for the AR1MA(p, q) model.
Return the parameter vector for the AR1MA(p, q) model.
Attributes
- Definition Classes
-
Forecaster -> Model
Pick one of the following vectors: v full first difference, u differenced, or u itself.
Pick one of the following vectors: v full first difference, u differenced, or u itself.
Value parameters
- u
-
the input time-series vector
Attributes
Predict a value for y_t+1 using the 1-step ahead forecast. y_t+1 = f (y_t, ...)
Predict a value for y_t+1 using the 1-step ahead forecast. y_t+1 = f (y_t, ...)
Value parameters
- t
-
the time point from which to make prediction
- y_
-
the actual values to use in making predictions
Attributes
Predict a value for y_t+1 using the 1-step ahead forecast. y_t+1 = f (y_t, ...) + e_t+1
Predict a value for y_t+1 using the 1-step ahead forecast. y_t+1 = f (y_t, ...) + e_t+1
Value parameters
- t
-
the time point from which to make prediction
- y_
-
the actual values to use in making predictions
Attributes
Predict all values corresponding to the given vector y_.
Predict all values corresponding to the given vector y_.
Value parameters
- y_
-
the actual values to use in making predictions
Attributes
- Definition Classes
Predict all values corresponding to the given vector y_.
Predict all values corresponding to the given vector y_.
Value parameters
- y_
-
the actual values to use in making predictions
Attributes
Test PREDICTIONS of an AR1MA forecasting model y_ = f(lags (y_)) + e and return its predictions and QoF vector. Testing may be in-sample (on the training set) or out-of-sample (on the testing set) as determined by the parameters passed in. Note: must call train before test.
Test PREDICTIONS of an AR1MA forecasting model y_ = f(lags (y_)) + e and return its predictions and QoF vector. Testing may be in-sample (on the training set) or out-of-sample (on the testing set) as determined by the parameters passed in. Note: must call train before test.
Value parameters
- x_null
-
the data/input matrix (ignored, pass null)
- y_
-
the training/testing/full response/output vector
Attributes
Test FORECASTS of an AR1MA forecasting model y_ = f(lags (y_)) + e and return its forecasts and QoF vector. Testing may be in-sample (on the training set) or out-of-sample (on the testing set) as determined by the parameters passed in. Note: must call train and forecastAll before testF.
Test FORECASTS of an AR1MA forecasting model y_ = f(lags (y_)) + e and return its forecasts and QoF vector. Testing may be in-sample (on the training set) or out-of-sample (on the testing set) as determined by the parameters passed in. Note: must call train and forecastAll before testF.
Value parameters
- h
-
the forecasting horizon, number of steps ahead to produce forecasts
- y_
-
the training/testing/full response/output vector
Attributes
Train/fit an AR1MA model to the times-series data in vector y_. Estimate the coefficient vectors φ and θ for (p, q)-th order AR1MA(p, q) model.
Train/fit an AR1MA model to the times-series data in vector y_. Estimate the coefficient vectors φ and θ for (p, q)-th order AR1MA(p, q) model.
Value parameters
- x_null
-
the data/input matrix (ignored, pass null)
- y_
-
the training/full response vector (e.g., full y)
Attributes
- Definition Classes
-
Forecaster -> Model
Train and test the forecasting model y_ = f(y-past) + e and report its QoF and plot its predictions. Return the predictions and QoF.
Train and test the forecasting model y_ = f(y-past) + e and report its QoF and plot its predictions. Return the predictions and QoF.
Value parameters
- y_
-
the training/full response/output vector (defaults to full y)
- yy
-
the testing/full response/output vector (defaults to full y)
Attributes
- Definition Classes
Inherited methods
Return the autocorrelation vector (ACF).
Return the maximum lag used by the model (its capacity to look into the past). Models that use more than one past value to make predictions/forecasts must override this method, e.g., ARMA (2, 3) should set the cap to max(p, q) = 3.
Return the maximum lag used by the model (its capacity to look into the past). Models that use more than one past value to make predictions/forecasts must override this method, e.g., ARMA (2, 3) should set the cap to max(p, q) = 3.
Attributes
- Inherited from:
- Forecaster
Diagnose the health of the model by computing the Quality of Fit (QoF) measures, from the error/residual vector and the predicted & actual responses. For some models the instances may be weighted.
Diagnose the health of the model by computing the Quality of Fit (QoF) measures, from the error/residual vector and the predicted & actual responses. For some models the instances may be weighted.
Value parameters
- w
-
the weights on the instances (defaults to null)
- y
-
the actual response/output vector to use (test/full)
- yp
-
the predicted response/output vector (test/full)
Attributes
- See also
-
Regression_WLS - Definition Classes
- Inherited from:
- Fit
Apply the Durbin-Levinson Algorithm to iteratively compute the psi matrix. The last/p-th row of the matrix gives AR coefficients. Note, also known as Levinson-Durbin.
Apply the Durbin-Levinson Algorithm to iteratively compute the psi matrix. The last/p-th row of the matrix gives AR coefficients. Note, also known as Levinson-Durbin.
Value parameters
- g
-
the auto-covariance vector (gamma)
- ml
-
the maximum number of lags
Attributes
- See also
- Inherited from:
- Correlogram
Return the Quality of Fit (QoF) measures corresponding to the labels given. Note, if sse > sst, the model introduces errors and the rSq may be negative, otherwise, R^2 (rSq) ranges from 0 (weak) to 1 (strong). Override to add more quality of fit measures.
Return the Quality of Fit (QoF) measures corresponding to the labels given. Note, if sse > sst, the model introduces errors and the rSq may be negative, otherwise, R^2 (rSq) ranges from 0 (weak) to 1 (strong). Override to add more quality of fit measures.
Attributes
- Inherited from:
- Fit
Forecast values for all y_.dim time points and all horizons (1 through h-steps ahead). Record these in the yf matrix, where yf(t, k) = k-steps ahead forecast for y_t Note, column 0, yf(?, 0), is set to y (the actual time-series values). Forecast recursively down diagonals in the yf forecasting matrix. The top right and bottom left triangles in yf matrix are not forecastable.
Forecast values for all y_.dim time points and all horizons (1 through h-steps ahead). Record these in the yf matrix, where yf(t, k) = k-steps ahead forecast for y_t Note, column 0, yf(?, 0), is set to y (the actual time-series values). Forecast recursively down diagonals in the yf forecasting matrix. The top right and bottom left triangles in yf matrix are not forecastable.
Value parameters
- h
-
the maximum forecasting horizon, number of steps ahead to produce forecasts
- y_
-
the actual values to use in making forecasts
Attributes
- Inherited from:
- Forecaster
Forecast intervals for all y_.dim time points at horizon h (h-steps ahead). Create prediction intervals (two vectors) for the given time points at level p. Caveat: assumes errors follow a Normal distribution. Override this method to handle other cases.
Forecast intervals for all y_.dim time points at horizon h (h-steps ahead). Create prediction intervals (two vectors) for the given time points at level p. Caveat: assumes errors follow a Normal distribution. Override this method to handle other cases.
Value parameters
- h
-
the forecasting horizon, number of steps ahead to produce forecasts
- p
-
the level (1 - alpha) for the prediction interval
- y_
-
the aligned actual values to use in making forecasts
- yfh
-
the forecast vector at horizon h
Attributes
- Inherited from:
- Forecaster
Perform forward selection to find the most predictive variable to add the existing model, returning the variable to add and the new model. May be called repeatedly. Note, all lags up and including 'p|q' define the model.
Perform forward selection to find the most predictive variable to add the existing model, returning the variable to add and the new model. May be called repeatedly. Note, all lags up and including 'p|q' define the model.
Value parameters
- cols
-
the lags/columns currently included in the existing model (currently ignored)
- idx_q
-
index of Quality of Fit (QoF) to use for comparing quality
Attributes
- See also
-
Fitfor index of QoF measures. - Inherited from:
- Forecaster
Perform forward selection to find the most predictive lags/variables to have in the model, returning the variables added and the new Quality of Fit (QoF) measures for all steps.
Perform forward selection to find the most predictive lags/variables to have in the model, returning the variables added and the new Quality of Fit (QoF) measures for all steps.
Value parameters
- cross
-
whether to include the cross-validation QoF measure (currently ignored)
- idx_q
-
index of Quality of Fit (QoF) to use for comparing quality
Attributes
- See also
-
Fitfor index of QoF measures. - Inherited from:
- Forecaster
Return the feature/variable names. Override for models like SARIMAX.
Return the feature/variable names. Override for models like SARIMAX.
Attributes
- Inherited from:
- Forecaster
Return the used response vector y. Mainly for derived classes where y is transformed, e.g., ARX.
Return the used response vector y. Mainly for derived classes where y is transformed, e.g., ARX.
Attributes
- Inherited from:
- Forecaster
Return the help string that describes the Quality of Fit (QoF) measures provided by the Fit trait. Override to correspond to fitLabel.
Return the help string that describes the Quality of Fit (QoF) measures provided by the Fit trait. Override to correspond to fitLabel.
Attributes
- Inherited from:
- Fit
Return the hyper-parameters.
The log-likelihood function times -2. Override as needed.
The log-likelihood function times -2. Override as needed.
Value parameters
- ms
-
raw Mean Squared Error
- s2
-
MLE estimate of the population variance of the residuals
Attributes
- See also
- Inherited from:
- Fit
Make a Correlogram, i.e., compute stats, psi and pacf.
Make a Correlogram, i.e., compute stats, psi and pacf.
Value parameters
- y_
-
the current (e.g., training) times-series to use (defaults to full y)
Attributes
- Inherited from:
- Correlogram
Return the mean of the squares for error (sse / df). Must call diagnose first.
Return the mean of the squares for error (sse / df). Must call diagnose first.
Attributes
- Inherited from:
- Fit
Attributes
- Inherited from:
- Forecaster
Return the partial autocorrelation vector (PACF).
Plot a function, e.g., Auto-Correlation Function (ACF), Partial Auto-Correlation Function (PACF) with confidence bound.
Plot a function, e.g., Auto-Correlation Function (ACF), Partial Auto-Correlation Function (PACF) with confidence bound.
Value parameters
- fVec
-
the vector given function values
- name
-
the name of the function
- show
-
whether to show the fVec values
Attributes
- Inherited from:
- Correlogram
The standard signature for prediction does not apply to time-series.
The standard signature for prediction does not apply to time-series.
Attributes
- Inherited from:
- Forecaster
Return the psi matrix.
Return the coefficient of determination (R^2). Must call diagnose first.
Return the coefficient of determination (R^2). Must call diagnose first.
Attributes
- Inherited from:
- FitM
Return a basic report on a trained and tested multi-variate model.
Return a basic report on a trained and tested multi-variate model.
Value parameters
- ftMat
-
the matrix of qof values produced by the
Fittrait
Attributes
- Inherited from:
- Model
Return a basic report on a trained and tested model.
Return a basic report on a trained and tested model.
Value parameters
- ftVec
-
the vector of qof values produced by the
Fittrait
Attributes
- Inherited from:
- Model
Reset the degrees of freedom to the new updated values. For some models, the degrees of freedom is not known until after the model is built.
Reset the degrees of freedom to the new updated values. For some models, the degrees of freedom is not known until after the model is built.
Value parameters
- df_update
-
the updated degrees of freedom (model, error)
Attributes
- Inherited from:
- Fit
Return the vector of residuals/errors.
Return the sum of the squares for error (sse). Must call diagnose first.
Return the sum of the squares for error (sse). Must call diagnose first.
Attributes
- Inherited from:
- FitM
Return basic statistics on time-series y or y_.
Produce a QoF summary for a model with diagnostics for each predictor x_j and the overall Quality of Fit (QoF). Note: `Fac_Cholesky is used to compute the inverse of xtx.
Produce a QoF summary for a model with diagnostics for each predictor x_j and the overall Quality of Fit (QoF). Note: `Fac_Cholesky is used to compute the inverse of xtx.
Value parameters
- b
-
the parameters/coefficients for the model
- fname
-
the array of feature/variable names
- vifs
-
the Variance Inflation Factors (VIFs)
- x_
-
the testing/full data/input matrix
Attributes
- Inherited from:
- Fit
Inherited fields
The optional reference to an ontological concept