Accelerating the pace of engineering and science

# Documentation

## Specify Conditional Mean Models Using arima

### Default ARIMA Model

The default ARIMA(p,D,q) model in Econometrics Toolbox™ is the nonseasonal model of the form

${\Delta }^{D}{y}_{t}=c+{\varphi }_{1}{\Delta }^{D}{y}_{t-1}+\dots +{\varphi }_{p}{\Delta }^{D}{y}_{t-p}+{\theta }_{1}{\epsilon }_{t-1}+\dots +{\theta }_{q}{\epsilon }_{t-q}+{\epsilon }_{t}.$

You can write this equation in condensed form using lag operator notation:

$\varphi \left(L\right){\left(1-L\right)}^{D}{y}_{t}=c+\theta \left(L\right){\epsilon }_{t}$

In either equation, the default innovation distribution is Gaussian with mean zero and constant variance.

You can specify a model of this form using the shorthand syntax arima(p,D,q). For the input arguments p, D, and q, enter the number of nonseasonal AR terms (p), the order of nonseasonal integration (D), and the number of nonseasonal MA terms (q), respectively.

When you use this shorthand syntax, arima creates an arima model with these default property values.

Property NameProperty Data Type
ARCell vector of NaNs
BetaEmpty vector [] of regression coefficients corresponding to exogenous covariates
ConstantNaN
DDegree of nonseasonal integration, D
Distribution'Gaussian'
MACell vector of NaNs
PNumber of AR terms plus degree of integration, p + D
QNumber of MA terms, q
SARCell vector of NaNs
SMACell vector of NaNs
VarianceNaN

To assign nondefault values to any properties, you can modify the created model object using dot notation.

Notice that the inputs D and q are the values arima assigns to properties D and Q. However, the input argument p is not necessarily the value arima assigns to the model property P. P stores the number of presample observations needed to initialize the AR component of the model. For nonseasonal models, the required number of presample observations is p + D.

To illustrate, consider specifying the ARIMA(2,1,1) model

$\left(1-{\varphi }_{1}L-{\varphi }_{2}{L}^{2}\right){\left(1-L\right)}^{1}{y}_{t}=c+\left(1+{\theta }_{1}L\right){\epsilon }_{t},$

where the innovation process is Gaussian with (unknown) constant variance.

```Mdl = arima(2,1,1)
```
```Mdl =

ARIMA(2,1,1) Model:
--------------------
Distribution: Name = 'Gaussian'
P: 3
D: 1
Q: 1
Constant: NaN
AR: {NaN NaN} at Lags [1 2]
SAR: {}
MA: {NaN} at Lags [1]
SMA: {}
Variance: NaN
```

Notice that the model property P does not have value 2 (the AR degree). With the integration, a total of p + D (here, 2 + 1 = 3) presample observations are needed to initialize the AR component of the model.

The created model, Mdl, has NaNs for all parameters. A NaN value signals that a parameter needs to be estimated or otherwise specified by the user. All parameters must be specified to forecast or simulate the model.

To estimate parameters, input the model object (along with data) to estimate. This returns a new fitted arima model object. The fitted model object has parameter estimates for each input NaN value.

Calling arima without any input arguments returns an ARIMA(0,0,0) model specification with default property values:

```DefaultMdl = arima
```
```DefaultMdl =

ARIMA(0,0,0) Model:
--------------------
Distribution: Name = 'Gaussian'
P: 0
D: 0
Q: 0
Constant: NaN
AR: {}
SAR: {}
MA: {}
SMA: {}
Variance: NaN
```

### Specify Nonseasonal Models Using Name-Value Pairs

The best way to specify models to arima is using name-value pair arguments. You do not need, nor are you able, to specify a value for every model object property. arima assigns default values to any properties you do not (or cannot) specify.

In condensed, lag operator notation, nonseasonal ARIMA(p,D,q) models are of the form

 $\varphi \left(L\right){\left(1-L\right)}^{D}{y}_{t}=c+\theta \left(L\right){\epsilon }_{t}.$ (5-2)

You can extend this model to an ARIMAX(p,D,q) model with the linear inclusion of exogenous variables. This model has the form

 $\varphi \left(L\right){y}_{t}={c}^{\ast }+{x}_{t}^{\prime }\beta +{\theta }^{\ast }\left(L\right){\epsilon }_{t},$ (5-3)

where c* = c/(1–L)D and θ*(L) = θ(L)/(1–L)D.

 Tip   If you specify a nonzero D, then Econometrics Toolbox differences the response series yt before the predictors enter the model. You should preprocess the exogenous covariates xt by testing for stationarity and differencing if any are unit root nonstationary. If any nonstationary exogenous covariate enters the model, then the false negative rate for significance tests of β can increase.

For the distribution of the innovations, εt, there are two choices:

• Independent and identically distributed (iid) Gaussian or Student's t with a constant variance, ${\sigma }_{\epsilon }^{2}$.

• Dependent Gaussian or Student's t with a conditional variance process, ${\sigma }_{t}^{2}$. Specify the conditional variance model using a garch, egarch, or gjr model.

The arima default for the innovations is an iid Gaussian process with constant (scalar) variance.

In order to estimate, forecast, or simulate a model, you must specify the parametric form of the model (e.g., which lags correspond to nonzero coefficients, the innovation distribution) and any known parameter values. You can set any unknown parameters equal to NaN, and then input the model to estimate (along with data) to get estimated parameter values.

arima (and estimate) returns a model corresponding to the model specification. You can modify models to change or update the specification. Input models (with no NaN values) to forecast or simulate for forecasting and simulation, respectively. Here are some example specifications using name-value arguments.

ModelSpecification
• ${y}_{t}=c+{\varphi }_{1}{y}_{t-1}+{\epsilon }_{t}$

• ${\epsilon }_{t}={\sigma }_{\epsilon }{z}_{t}$

• zt Gaussian

arima('AR',NaN) or arima(1,0,0)
• ${y}_{t}={\epsilon }_{t}+{\theta }_{1}{\epsilon }_{t-1}+{\theta }_{2}{\epsilon }_{t-2}$

• ${\epsilon }_{t}={\sigma }_{\epsilon }{z}_{t}$

• zt Student's t with unknown degrees of freedom

arima('Constant',0,'MA',{NaN,NaN},...
'Distribution','t')
• $\left(1-0.8L\right)\left(1-L\right){y}_{t}=0.2+\left(1+0.6L\right){\epsilon }_{t}$

• ${\epsilon }_{t}=0.1{z}_{t}$

• zt Student's t with eight degrees of freedom

arima('Constant',0.2,'AR',0.8,'MA',0.6,...
'Variance',0.1,'Distribution',...
struct('Name','t','DoF',8))
• $\left(1+0.5L\right){\left(1-L\right)}^{1}\Delta {y}_{t}={x}_{t}^{\prime }\left[\begin{array}{c}-5\\ 2\end{array}\right]+{\epsilon }_{t}$

• ${\epsilon }_{t}~N\left(0,1\right)$

arima('AR',-0.5,'D',1,'Beta',[-5 2])

You can specify the following name-value arguments to create nonseasonal arima models.

Name-Value Arguments for Nonseasonal ARIMA Models

NameCorresponding Model Term(s) in Equation 5-2When to Specify
ARNonseasonal AR coefficients, ${\varphi }_{1},\dots ,{\varphi }_{p}$To set equality constraints for the AR coefficients. For example, to specify the AR coefficients in the model

${y}_{t}=0.8{y}_{t-1}-0.2{y}_{t-2}+{\epsilon }_{t},$

specify 'AR',{0.8,-0.2}

You only need to specify the nonzero elements of AR. If the nonzero coefficients are at nonconsecutive lags, specify the corresponding lags using ARLags.

Any coefficients you specify must correspond to a stable AR operator polynomial.
ARLagsLags corresponding to nonzero, nonseasonal AR coefficientsARLags is not a model property.
Use this argument as a shortcut for specifying AR when the nonzero AR coefficients correspond to nonconsecutive lags. For example, to specify nonzero AR coefficients at lags 1 and 12, e.g., ${y}_{t}={\varphi }_{1}{y}_{t-1}+{\varphi }_{12}{y}_{t-12}+{\epsilon }_{t},$

specify 'ARLags',[1,12].

Use AR and ARLags together to specify known nonzero AR coefficients at nonconsecutive lags. For example, if in the given AR(12) model ${\varphi }_{1}=0.6$ and ${\varphi }_{12}=-0.3,$ specify 'AR',{0.6,-0.3},'ARLags',[1,12].
BetaValues of the coefficients of the exogenous covariatesUse this argument to specify the values of the coefficients of the exogenous variables. For example, use 'Beta',[0.5 7 -2] to specify $\beta ={\left[\begin{array}{ccc}0.5& 7& -2\end{array}\right]}^{\prime }.$

By default, Beta is an empty vector.

ConstantConstant term, cTo set equality constraints for c. For example, for a model with no constant term, specify 'Constant',0.
By default, Constant has value NaN.
DDegree of nonseasonal differencing, DTo specify a degree of nonseasonal differencing greater than zero. For example, to specify one degree of differencing, specify 'D',1.
By default, D has value 0 (meaning no nonseasonal integration).
DistributionDistribution of the innovation processUse this argument to specify a Student's t innovation distribution. By default, the innovation distribution is Gaussian.
For example, to specify a t distribution with unknown degrees of freedom, specify 'Distribution','t'.
To specify a t innovation distribution with known degrees of freedom, assign Distribution a data structure with fields Name and DoF. For example, for a t distribution with nine degrees of freedom, specify 'Distribution',struct('Name','t','DoF',9).
MANonseasonal MA coefficients, ${\theta }_{1},\dots ,{\theta }_{q}$To set equality constraints for the MA coefficients. For example, to specify the MA coefficients in the model

${y}_{t}={\epsilon }_{t}+0.5{\epsilon }_{t-1}+0.2{\epsilon }_{t-2},$

specify 'MA',{0.5,0.2}.

You only need to specify the nonzero elements of MA. If the nonzero coefficients are at nonconsecutive lags, specify the corresponding lags using MALags.

Any coefficients you specify must correspond to an invertible MA polynomial.
MALagsLags corresponding to nonzero, nonseasonal MA coefficientsMALags is not a model property.
Use this argument as a shortcut for specifying MA when the nonzero MA coefficients correspond to nonconsecutive lags. For example, to specify nonzero MA coefficients at lags 1 and 4, e.g.,

${y}_{t}={\epsilon }_{t}+{\theta }_{1}{\epsilon }_{t-1}+{\theta }_{4}{\epsilon }_{t-4},$

specify 'MALags',[1,4].

Use MA and MALags together to specify known nonzero MA coefficients at nonconsecutive lags. For example, if in the given MA(4) model ${\theta }_{1}=0.5$ and ${\theta }_{4}=0.2,$ specify 'MA',{0.4,0.2},'MALags',[1,4].
Variance
• Scalar variance of the innovation process, ${\sigma }_{\epsilon }^{2}$

• Conditional variance process, ${\sigma }_{t}^{2}$

• To set equality constraints for ${\sigma }_{\epsilon }^{2}$. For example, for a model with known variance 0.1, specify 'Variance',0.1. By default, Variance has value NaN.

• To specify a conditional variance model, ${\sigma }_{t}^{2}$. Set 'Variance' equal to a conditional variance model object, e.g., a garch model object.

 Note:   You cannot assign values to the properties P and Q. For nonseasonal models,arima sets P equal to p + Darima sets Q equal to q

### Specify Multiplicative Models Using Name-Value Pairs

For a time series with periodicity s, define the degree ps seasonal AR operator polynomial, $\Phi \left(L\right)=\left(1-{\Phi }_{1}{L}^{{p}_{1}}-\dots -{\Phi }_{{p}_{s}}{L}^{{p}_{s}}\right)$, and the degree qs seasonal MA operator polynomial, $\Theta \left(L\right)=\left(1+{\Theta }_{1}{L}^{{q}_{1}}+\dots +{\Theta }_{{q}_{s}}{L}^{{q}_{s}}\right)$. Similarly, define the degree p nonseasonal AR operator polynomial, $\varphi \left(L\right)=\left(1-{\varphi }_{1}L-\dots -{\varphi }_{p}{L}^{p}\right)$, and the degree q nonseasonal MA operator polynomial,

 $\theta \left(L\right)=\left(1+{\theta }_{1}L+\dots +{\theta }_{q}{L}^{q}\right).$ (5-4)

A multiplicative ARIMA model with degree D nonseasonal integration and degree s seasonality is given by

 $\varphi \left(L\right)\Phi \left(L\right){\left(1-L\right)}^{D}\left(1-{L}^{s}\right){y}_{t}=c+\theta \left(L\right)\Theta \left(L\right){\epsilon }_{t}.$ (5-5)

The innovation series can be an independent or dependent Gaussian or Student's t process. The arima default for the innovation distribution is an iid Gaussian process with constant (scalar) variance.

In addition to the arguments for specifying nonseasonal models (described in Name-Value Arguments for Nonseasonal ARIMA Models), you can specify these name-value arguments to create a multiplicative arima model. You can extend an ARIMAX model similarly to include seasonal effects.

Name-Value Arguments for Seasonal ARIMA Models

ArgumentCorresponding Model Term(s) in Equation 5-5When to Specify
SARSeasonal AR coefficients, ${\Phi }_{1},\dots ,{\Phi }_{{p}_{s}}$To set equality constraints for the seasonal AR coefficients. When specifying AR coefficients, use the sign opposite to what appears in Equation 5-5 (that is, use the sign of the coefficient as it would appear on the right side of the equation).
Use SARLags to specify the lags of the nonzero seasonal AR coefficients. Specify the lags associated with the seasonal polynomials in the periodicity of the observed data (e.g., 4, 8,... for quarterly data, or 12, 24,... for monthly data), and not as multiples of the seasonality (e.g., 1, 2,...).
For example, to specify the model

$\left(1-0.8L\right)\left(1-0.2{L}^{12}\right){y}_{t}={\epsilon }_{t},$

specify 'AR',0.8,'SAR',0.2,'SARLags',12

.
Any coefficient values you enter must correspond to a stable seasonal AR polynomial.
SARLagsLags corresponding to nonzero seasonal AR coefficients, in the periodicity of the observed seriesSARLags is not a model property.
Use this argument when specifying SAR to indicate the lags of the nonzero seasonal AR coefficients.
For example, to specify the model

$\left(1-\varphi L\right)\left(1-{\Phi }_{12}{L}^{12}\right){y}_{t}={\epsilon }_{t},$

specify 'ARLags',1,'SARLags',12.

SMASeasonal MA coefficients, ${\Theta }_{1},\dots ,{\Theta }_{{q}_{s}}$To set equality constraints for the seasonal MA coefficients.
Use SMALags to specify the lags of the nonzero seasonal MA coefficients. Specify the lags associated with the seasonal polynomials in the periodicity of the observed data (e.g., 4, 8,... for quarterly data, or 12, 24,... for monthly data), and not as multiples of the seasonality (e.g., 1, 2,...).
For example, to specify the model

${y}_{t}=\left(1+0.6L\right)\left(1+0.2{L}^{12}\right){\epsilon }_{t},$

specify 'MA',0.6,'SMA',0.2,'SMALags',12.

Any coefficient values you enter must correspond to an invertible seasonal MA polynomial.
SMALagsLags corresponding to the nonzero seasonal MA coefficients, in the periodicity of the observed seriesSMALags is not a model property.
Use this argument when specifying SMA to indicate the lags of the nonzero seasonal MA coefficients.
For example, to specify the model

${y}_{t}=\left(1+{\theta }_{1}L\right)\left(1+{\Theta }_{4}{L}^{4}\right){\epsilon }_{t},$

specify 'MALags',1,'SMALags',4.

SeasonalitySeasonal periodicity, sTo specify the degree of seasonal integration s in the seasonal differencing polynomial Δs = 1 – Ls. For example, to specify the periodicity for seasonal integration of monthly data, specify 'Seasonality',12.
If you specify nonzero Seasonality, then the degree of the whole seasonal differencing polynomial is one. By default, Seasonality has value 0 (meaning periodicity and no seasonal integration).

 Note:   You cannot assign values to the properties P and Q. For multiplicative ARIMA models,arima sets P equal to p + D + ps + sarima sets Q equal to q + qs