arima
Create univariate autoregressive integrated moving average (ARIMA) model
Description
The arima
function returns an arima
object specifying the functional form and storing the parameter values of an ARIMA(p,D,q) linear time series model for a univariate response process y_{t}.
arima
enables you to create variations of the ARIMA model, including:
An autoregressive (AR(p)), moving average (MA(q)), or ARMA(p,q) model.
A model containing multiplicative seasonal components (SARIMA(p,D,q)⨉(p_{s},D_{s},q_{s})_{s}).
A model containing a linear regression component for exogenous covariates (ARIMAX).
A composite conditional mean and conditional variance model. For example, you can create an ARMA conditional mean model containing a GARCH conditional variance model (
garch
).
The key components of an arima
object are the polynomial degrees (for example, the AR polynomial degree p and the degree of integration D) because they completely specify the model structure. Given polynomial degrees, all other parameters, such as coefficients and innovationdistribution parameters, are unknown and estimable unless you specify their values.
To estimate a model containing unknown parameter values, pass the model and data to estimate
. To work with an estimated or fully specified arima
object, pass it to an object function.
Alternatively, you can:
Create and work with
arima
model objects interactively by using Econometric Modeler.Model serial correlation in a disturbance series of a regression model by creating a regression model with ARIMA errors. For more details, see
regARIMA
and Alternative ARIMA Model Representations.
Creation
Description
creates an ARIMA(0,0,0) model containing only an unknown constant and a series of iid Gaussian innovations with mean 0 and an unknown variance.Mdl
= arima
creates an ARIMA(Mdl
= arima(p
,D
,q
)p
,D
,q
) model containing nonseasonal AR polynomial lags from 1 through p
, the degree D
nonseasonal integration polynomial, and nonseasonal MA polynomial lags from 1 through q
.
This shorthand syntax provides an easy way to create a model template in which you specify the degrees of the nonseasonal polynomials explicitly. The model template is suited for unrestricted parameter estimation. After you create a model, you can alter property values using dot notation.
sets properties and polynomial lags using namevalue pair arguments. Enclose each name in quotes. For example, Mdl
= arima(Name,Value
)'ARLags',[1 4],'AR',{0.5 –0.1}
specifies the values –0.5
and 0.1
for the nonseasonal AR polynomial coefficients at lags 1
and 4
, respectively.
This longhand syntax allows you to create more flexible models. arima
infers all polynomial degrees from the properties that you set. Therefore, property values that correspond to polynomial degrees must be consistent with each other.
Input Arguments
The shorthand syntax provides an easy way for you to create nonseasonal ARIMA model templates that are suitable for unrestricted parameter estimation. For example, to create an ARMA(2,1) model containing unknown coefficients and innovations variance, enter:
Mdl = arima(2,0,1);
p
— Nonseasonal autoregressive polynomial degree
nonnegative integer
Nonseasonal autoregressive polynomial degree, specified as a nonnegative integer.
Data Types: double
D
— Degree of nonseasonal integration
nonnegative integer
Degree of nonseasonal integration (the degree of the nonseasonal differencing polynomial), specified as a nonnegative integer. D
sets the property D.
Data Types: double
q
— Nonseasonal moving average polynomial degree
nonnegative integer
Nonseasonal moving average polynomial degree, specified as a nonnegative integer.
Data Types: double
Specify optional pairs of arguments as
Name1=Value1,...,NameN=ValueN
, where Name
is
the argument name and Value
is the corresponding value.
Namevalue arguments must appear after other arguments, but the order of the
pairs does not matter.
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
The longhand syntax enables you to create seasonal models or models in which some or all coefficients are known. During estimation, estimate
imposes equality constraints on any known parameters.
Example: 'ARLags',[1 4],'AR',{0.5 –0.1}
specifies the nonseasonal AR polynomial $$10.5{L}^{1}+0.1{L}^{4}$$.
ARLags
— Lags associated with nonseasonal AR polynomial coefficients
1:numel(AR)
(default)  numeric vector of unique positive integers
Lags associated with the nonseasonal AR polynomial coefficients, specified as the commaseparated pair consisting of 'ARLags'
and a numeric vector of unique positive integers. The maximum lag is p.
AR{
is the coefficient of lag
j
}ARLags(
, where
j
)AR
is the value of the property AR
.
Example: ARLags=4
specifies the nonseasonal AR polynomial$$1{\varphi}_{4}{L}^{4}$$.
Example: ARLags=1:4
specifies the nonseasonal AR polynomial$$1{\varphi}_{1}{L}^{1}{\varphi}_{2}{L}^{2}{\varphi}_{3}{L}^{3}{\varphi}_{4}{L}^{4}$$.
Example: ARLags=[1 4]
specifies the nonseasonal AR polynomial $$1{\varphi}_{1}{L}^{1}{\varphi}_{4}{L}^{4}.$$
Data Types: double
MALags
— Lags associated with nonseasonal MA polynomial coefficients
1:numel(MA)
(default)  numeric vector of unique positive integers
Lags associated with the nonseasonal MA polynomial coefficients, specified as the commaseparated pair consisting of 'MALags'
and a numeric vector of unique positive integers. The maximum lag is q.
MA{
is the coefficient of lag
j
}MALags(
, where
j
)MA
is the value of the property MA
.
Example: MALags=3
specifies the nonseasonal MA polynomial $$1+{\theta}_{3}{L}^{3}$$.
Example: MALags=1:3
specifies the nonseasonal MA polynomial $$1+{\theta}_{1}{L}^{1}+{\theta}_{2}{L}^{2}+{\theta}_{3}{L}^{3}.$$
Example: MALags=[1 3]
specifies the nonseasonal MA polynomial $$1+{\theta}_{1}{L}^{1}+{\theta}_{3}{L}^{3}$$.
Data Types: double
SARLags
— Lags associated with seasonal AR polynomial coefficients
1:numel(SAR)
(default)  numeric vector of unique positive integers
Lags associated with the seasonal AR polynomial coefficients, specified as the commaseparated pair consisting of 'SARLags'
and a numeric vector of unique positive integers. The maximum lag is p_{s}.
SAR{
is the coefficient of lag
j
}SARLags(
, where
j
)SAR
is the value of the property
SAR
.
Specify SARLags
as the periodicity of the observed data, and not as multiples of the Seasonality
property. This convention does not conform to standard Box and Jenkins [1] notation, but it is more flexible for incorporating multiplicative seasonality.
Example: 'SARLags',[4 8]
specifies the seasonal AR polynomial $$1{\Phi}_{4}{L}^{4}{\Phi}_{8}{L}^{8}.$$
Data Types: double
SMALags
— Lags associated with seasonal MA polynomial coefficients
1:numel(SMA)
(default)  numeric vector of unique positive integers
Lags associated with the seasonal MA polynomial coefficients, specified as the commaseparated pair consisting of 'SMALags'
and a numeric vector of unique positive integers. The maximum lag is q_{s}.
SMA{
is the coefficient of lag
j
}SMALags(
, where
j
)SMA
is the value of the property
SMA
.
Specify SMALags
as the periodicity of the observed data, and not as multiples of the Seasonality
property. This convention does not conform to standard Box and Jenkins [1] notation, but it is more flexible for incorporating multiplicative seasonality.
Example: 'SMALags',4
specifies the seasonal MA polynomial $$1+{\Theta}_{4}{L}^{4}.$$
Data Types: double
Note
Polynomial degrees are not estimable. If you do not specify a polynomial degree, or arima
cannot infer it from other specifications, arima
does not include the polynomial in the model.
Properties
You can set writable property values when you create the model object by using namevalue argument syntax, or after you create the model object by using dot notation. For example, to create a fully specified ARMA(2,1) model, enter:
Mdl = arima('Constant',1,'AR',{0.3 0.15},'MA',0.2); Mdl.Variance = 1;
Note
NaN
valued properties indicate estimable parameters. Numeric properties indicate equality constraints on parameters during model estimation. Coefficient vectors can contain both numeric andNaN
valued elements.You can specify polynomial coefficients as vectors in any orientation, but
arima
stores them as row vectors.
P
— Compound AR polynomial degree
nonnegative integer
This property is readonly.
Compound AR polynomial degree, specified as a nonnegative integer.
P
does not necessarily conform to standard Box and Jenkins notation [1] because P
captures the degrees of the nonseasonal and seasonal AR polynomials (properties AR
and SAR
, respectively), nonseasonal integration (property D
), and seasonality (property Seasonality
). Explicitly, P
= p + D + p_{s} + s. P
conforms to Box and Jenkins notation for models without integration or a seasonal AR component.
P
specifies the number of lagged observations required to initialize the AR components of the model.
Data Types: double
Q
— Compound MA polynomial degree
nonnegative integer
This property is readonly.
Compound MA polynomial degree, specified as a nonnegative integer.
Q
does not necessarily conform to standard Box and Jenkins notation [1] because Q
captures the degrees of the nonseasonal and seasonal MA polynomials (properties MA
and SMA
, respectively). Explicitly, Q
= q + q_{s}. Q
conforms to Box and Jenkins notation for models without a seasonal MA component.
Q
specifies the number of lagged innovations required to initialize the MA components of the model.
Data Types: double
Description
— Model description
string scalar  character vector
Model description, specified as a string scalar or character vector. arima
stores the value as a string scalar. The default value describes the parametric form of the model, for example
"ARIMAX(1,1,1) Model (Gaussian Distribution)"
.
Example: "Model 1"
Data Types: string
 char
Distribution
— Conditional probability distribution of innovation process ε_{t}
"Gaussian"
(default)  "t"
 structure array
Conditional probability distribution of the innovation process
ε_{t}, specified as a string or structure
array. arima
stores the value as a structure array.
Distribution  String  Structure Array 

Gaussian  "Gaussian"  struct('Name',"Gaussian") 
Student’s t  "t"  struct('Name',"t",'DoF',DoF) 
The 'DoF'
field specifies the t distribution
degrees of freedom parameter.
DoF
> 2 orDoF
=NaN
.DoF
is estimable.If you specify
"t"
,DoF
isNaN
by default. You can change its value by using dot notation after you create the model. For example,Mdl.Distribution.DoF = 3
.If you supply a structure array to specify the Student's t distribution, then you must specify both the
'Name'
and the'DoF'
fields.
Example: Distribution=struct('Name',"t",'DoF',10)
Constant
— Model constant
NaN
(default)  numeric scalar
Model constant, specified as a numeric scalar.
Example: 1
Data Types: double
AR
— Nonseasonal AR polynomial coefficients
cell vector
Nonseasonal AR polynomial coefficients, specified as a cell vector. Cells contain numeric scalars or NaN
values. A fully specified nonseasonal AR polynomial must be stable.
Coefficient signs correspond to the model expressed in differenceequation notation. For example, for the nonseasonal AR polynomial $$\varphi \left(L\right)=10.5L+0.1{L}^{2},$$ specify 'AR',{0.5 –0.1}
.
If you do not set the 'ARLags'
namevalue pair argument, AR{
is the
coefficient of lag j
}j
, j
=
1,…,p, where p =
numel(AR)
.
Otherwise, p = max(ARLags)
and the following
conditions apply:
The lengths of
AR
andARLags
must be equal.AR{
is the coefficient of lagj
}ARLags(
, for eachj
)
.j
arima
storesAR
as a length p cell vector. All cells that do not correspond to lags inARLags
contain0
.
The default value of AR
depends on other specifications:
If you use the shorthand syntax to specify
p
> 0,AR
is a lengthp
cell vector, where each cell contains aNaN
value.If you specify
ARLags
,AR
is a length p cell vector.AR{
=j
}NaN
for each lagARLags(
. All other cells containj
)0
.Otherwise,
AR
is an empty cell vector{}
, meaning the model does not contain a nonseasonal AR polynomial.
The coefficients in AR
correspond to coefficients in an
underlying LagOp
lag operator polynomial, and are subject to
a nearzero tolerance exclusion test. If a coefficient is 1e–12
or
below, arima
excludes that coefficient and its corresponding lag
in ARLags
from the model.
Example: {0.8}
Example: {NaN –0.1}
Data Types: cell
SAR
— Seasonal AR polynomial coefficients
cell vector
Seasonal AR polynomial coefficients, specified as a cell vector. Cells contain numeric scalars or NaN
values. A fully specified seasonal AR polynomial must be stable.
Coefficient signs correspond to the model expressed in differenceequation notation. For example, for the seasonal AR polynomial $$\Phi \left(L\right)=10.5{L}^{4}+0.1{L}^{8},$$ specify 'SAR',{0.5 –0.1}
.
If you do not set the 'SARLags'
namevalue pair argument, SAR{
is the
coefficient of lag j
}j
, j
=
1,…,p_{s}, where
p_{s} = numel(SAR)
.
Otherwise, p_{s} =
max(SARLags)
and the following conditions apply:
The lengths of
SAR
andSARLags
must be equal.SAR{
is the coefficient of lagj
}SARLags(
, for eachj
)
.j
arima
storesSAR
as a length p_{s} cell vector. All cells that do not correspond to lags inSARLags
contain0
.
The default value of SAR
depends on the value
SARLags
:
If you specify
SARLags
,SAR
is a length p_{s} cell vector.SAR{
=j
}NaN
for each lagSARLags(
. All other cells containj
)0
.Otherwise,
SAR
is an empty cell vector{}
, meaning the model does not contain a seasonal AR polynomial.
The coefficients in SAR
correspond to coefficients in an
underlying LagOp
lag operator polynomial, and are subject to
a nearzero tolerance exclusion test. If a coefficient is 1e–12
or
below, arima
excludes that coefficient and its corresponding lag
in SARLags
from the model.
Example: {0.2 0.1}
Example: {NaN 0 0 NaN}
Data Types: cell
MA
— Nonseasonal MA polynomial coefficients
cell vector
Nonseasonal MA polynomial coefficients, specified as a cell vector. Cells contain numeric scalars or NaN
values. A fully specified nonseasonal MA polynomial must be invertible.
If you do not set the 'MALags'
namevalue pair argument, MA{
is the
coefficient of lag j
}j
, j
=
1,…,q, where q =
numel(MA)
.
Otherwise, q = max(MALags)
and the following
conditions apply:
The lengths of
MA
andMALags
must be equal.MA{
is the coefficient of lagj
}MALags(
, for eachj
)
.j
arima
storesMA
as a length q cell vector. All cells that do not correspond to lags inMALags
contain0
.
The default value of MA
depends on other specifications:
If you use the shorthand syntax to specify
q
> 0,MA
is a lengthq
cell vector, where each cell contains aNaN
value.If you specify
MALags
,MA
is a length q cell vector.MA{
=j
}NaN
for each lagMALags(
. All other cells containj
)0
.Otherwise,
MA
is an empty cell vector{}
, meaning the model does not contain a nonseasonal MA polynomial.
The coefficients in SMA
correspond to coefficients in an
underlying LagOp
lag operator polynomial, and are subject to
a nearzero tolerance exclusion test. If a coefficient is 1e–12
or
below, arima
excludes that coefficient and its corresponding lag
in SMALags
from the model.
Example: 0.8
Example: {NaN –0.1}
Data Types: cell
SMA
— Seasonal MA polynomial coefficients
cell vector
Seasonal MA polynomial coefficients, specified as a cell vector. Cells contain numeric scalars or NaN
values. A fully specified seasonal MA polynomial must be invertible.
If you do not set the 'SMALags'
namevalue pair argument, SMA{
is the
coefficient of lag j
}j
, j
=
1,…,q_{s}, where
q_{s} = numel(SMA)
.
Otherwise, q_{s} =
max(SMALags)
and the following conditions apply:
The lengths of
SMA
andSMALags
must be equal.SMA{
is the coefficient of lagj
}SMALags(
, for eachj
)
.j
arima
storesSMA
as a length q_{s} cell vector. All cells that do not correspond to lags inSMALags
contain0
.
The default value of SMA
depends on other specifications:
If you specify
SMALags
,SMA
is a length q_{s} cell vector.SMA{
=j
}NaN
for each lagSMALags(
. All other cells containj
)0
.Otherwise,
SMA
is an empty cell vector{}
, meaning the model does not contain a seasonal MA polynomial.
The coefficients in SMA
correspond to coefficients in an
underlying LagOp
lag operator polynomial, and are subject to
a nearzero tolerance exclusion test. If a coefficient is 1e–12
or
below, arima
excludes that coefficient and its corresponding lag
in SMALags
from the model.
Example: {0.2 0.1}
Example: {NaN 0 0 NaN}
Data Types: cell
D
— Degree of nonseasonal integration
0
(default)  nonnegative integer
Degree of nonseasonal integration, or the degree of the nonseasonal differencing polynomial, specified as a nonnegative integer.
Example: 1
Data Types: double
Seasonality
— Degree of seasonal differencing polynomial
0
(default)  nonnegative integer
Degree of the seasonal differencing polynomial s, specified as a nonnegative integer.
Example: 12
specifies monthly periodicity.
Data Types: double
Beta
— Regression component coefficients
empty row vector (default)  numeric vector
Regression component coefficients of the conditional mean, specified as a numeric vector.
If you plan to estimate all elements of Beta
, you do not need to specify it. During estimation, estimate
infers the size of Beta
from the number of columns of the specified exogenous data X
.
Example: [0.5 NaN 3]
Data Types: double
Variance
— Model innovations variance
NaN
(default)  positive scalar  supported conditional variance model object
Model innovations variance, specified as a positive scalar or a supported conditional variance model object (for example, garch
). For all supported conditional variance models, see Conditional Variance Models.
A positive scalar or NaN
specifies a homoscedastic model. A conditional variance model object specifies a composite conditional mean and variance model. estimate
fits all unknown, estimable parameters in the composition.
Example: 1
Example: garch(1,0)
Data Types: double
SeriesName
— Response series name
string scalar  character vector  "Y"
Since R2023b
Response series name, specified as a string scalar or character vector. arima
stores the value as a string scalar.
Example: "StockReturn"
Data Types: string
 char
Object Functions
estimate  Fit univariate ARIMA or ARIMAX model to data 
summarize  Display univariate ARIMA or ARIMAX model estimation results 
infer  Infer univariate ARIMA or ARIMAX model residuals or conditional variances 
filter  Filter disturbances using univariate ARIMA or ARIMAX model 
impulse  Generate univariate ARIMA model impulse response function (IRF) 
simulate  Monte Carlo simulation of univariate ARIMA or ARIMAX models 
forecast  Forecast univariate ARIMA or ARIMAX model responses or conditional variances 
Examples
Create Default Model
Create a default regression model with ARIMA errors by using regARIMA
.
Mdl = regARIMA
Mdl = regARIMA with properties: Description: "ARMA(0,0) Error Model (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" Intercept: NaN Beta: [1×0] P: 0 Q: 0 AR: {} SAR: {} MA: {} SMA: {} Variance: NaN
Mdl
is an regARIMA
object. Properties of the model appear at the command line.
The default model is
$$\begin{array}{l}{y}_{t}=c+{u}_{t}\\ {u}_{t}={\epsilon}_{t},\end{array}$$
where $\mathit{c}$ is an unknown constant and ${\epsilon}_{\mathit{t}}\text{\hspace{0.17em}}$ is a series of iid Gaussian random variables with mean 0 and variance ${\sigma}^{2}$.
Mdl
is a model template for estimation. You can modify property values by using dot notation or fit the model to data by using estimate
, but you cannot pass Mdl
to any other object function.
Create Default Model
Create a default ARIMA model by using arima
.
Mdl = arima
Mdl = arima with properties: Description: "ARIMA(0,0,0) Model (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" P: 0 D: 0 Q: 0 Constant: NaN AR: {} SAR: {} MA: {} SMA: {} Seasonality: 0 Beta: [1×0] Variance: NaN
Mdl
is an arima
object. Properties of the model appear at the command line.
The default model is
$${y}_{t}=c+{\epsilon}_{t}$$,
where $\mathit{c}$ is an unknown constant and ${\epsilon}_{\mathit{t}}\text{\hspace{0.17em}}$ is a series of iid Gaussian random variables with mean 0 and variance ${\sigma}^{2}$.
Mdl
is a model template for estimation. You can modify property values by using dot notation or fit the model to data by using estimate
, but you cannot pass Mdl
to any other object function.
Create Fully Specified Model
Create the ARIMA(2,1,1) model represented by this equation:
$$(1+0.5{L}^{2})(1L){y}_{t}=3.1+(10.2L){\epsilon}_{t},$$
where ${\epsilon}_{\mathit{t}}$ is a series of iid Gaussian random variables. Use the longhand syntax to specify parameter values in the equation written in differenceequation notation:
$$\Delta {y}_{t}=3.10.5\Delta {y}_{t2}+{\epsilon}_{t}0.2{\epsilon}_{t1}.$$
Mdl = arima('ARLags',2,'AR',0.5,'D',1,'MA',0.2,... 'Constant',3.1)
Mdl = arima with properties: Description: "ARIMA(2,1,1) Model (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" P: 3 D: 1 Q: 1 Constant: 3.1 AR: {0.5} at lag [2] SAR: {} MA: {0.2} at lag [1] SMA: {} Seasonality: 0 Beta: [1×0] Variance: NaN
Mdl
is a fully specified arima
object because all its parameters are known. You can pass Mdl
to any arima
object function except estimate
. For example, plot the impulse response function of the model for 24 periods by using impulse
.
impulse(Mdl,24)
Create Partially Specified Model
Create the AR(1) model represented by this equation:
$${y}_{t}=1+\varphi {y}_{t1}+{\epsilon}_{t},$$
where ${\epsilon}_{\mathit{t}}$ is a series of iid Gaussian random variables with mean 0 and variance 0.5. Use the shorthand syntax to specify an AR(1) model template, then use dot notation to set the Constant
and Variance
properties.
Mdl = arima(1,0,0); Mdl.Constant = 1; Mdl.Variance = 0.5; Mdl
Mdl = arima with properties: Description: "ARIMA(1,0,0) Model (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" P: 1 D: 0 Q: 0 Constant: 1 AR: {NaN} at lag [1] SAR: {} MA: {} SMA: {} Seasonality: 0 Beta: [1×0] Variance: 0.5
Mdl
is a partially specified arima
object. You can modify property values by using dot notation or fit the unknown coefficient $\varphi $ to data by using estimate
, but you cannot pass Mdl
to any other object function.
Create Nonseasonal ARIMA Model Template
Create the ARIMA(3,1,2) model represented by this equation:
$$(1{\varphi}_{1}L{\varphi}_{2}{L}^{2}{\varphi}_{3}{L}^{3})(1L){y}_{t}=(1+{\theta}_{1}L+{\theta}_{2}{L}^{2}){\epsilon}_{t}$$,
where ${\epsilon}_{\mathit{t}}$ is a series of iid Gaussian random variables with mean 0 and variance ${\sigma}^{2}$.
Because the model contains only nonseasonal polynomials, use the shorthand syntax.
Mdl = arima(3,1,2)
Mdl = arima with properties: Description: "ARIMA(3,1,2) Model (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" P: 4 D: 1 Q: 2 Constant: NaN AR: {NaN NaN NaN} at lags [1 2 3] SAR: {} MA: {NaN NaN} at lags [1 2] SMA: {} Seasonality: 0 Beta: [1×0] Variance: NaN
The property P
is equal to $$p$$ + $$D$$ = 4
. NaN
valued elements indicate estimable parameters.
Specify Nonconsecutive Lags
To include additive seasonal lags, specify the lags matching the appropriate periodicity. For example, create the additive monthly MA(12) model represented in this equation:
$${y}_{t}={\epsilon}_{t}+{\theta}_{1}{\epsilon}_{t1}+{\theta}_{12}{\epsilon}_{t12},$$
where ${\epsilon}_{\mathit{t}}$ is a series of iid Gaussian random variables with mean 0 and variance ${\sigma}^{2}$.
Mdl = arima('Constant',0,'MALags',[1 12])
Mdl = arima with properties: Description: "ARIMA(0,0,12) Model (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" P: 0 D: 0 Q: 12 Constant: 0 AR: {} SAR: {} MA: {NaN NaN} at lags [1 12] SMA: {} Seasonality: 0 Beta: [1×0] Variance: NaN
Create SARIMA Model Template
Create the SARIMA$\left(0,1,1\right)\times {\left(0,1,1\right)}_{12}$ model (multiplicative, monthly MA model template with one degree of seasonal and nonseasonal integration) represented by this equation:
$$(1L)(1{L}^{12}){y}_{t}=(1+{\theta}_{1}L)(1+{\theta}_{12}{L}^{12}){\epsilon}_{t},$$
where ${\epsilon}_{\mathit{t}}$ is a series of iid Gaussian random variables with mean 0 and variance ${\sigma}^{2}$.
Mdl = arima('Constant',0,'D',1,'Seasonality',12,... 'MALags',1,'SMALags',12)
Mdl = arima with properties: Description: "ARIMA(0,1,1) Model Seasonally Integrated with Seasonal MA(12) (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" P: 13 D: 1 Q: 13 Constant: 0 AR: {} SAR: {} MA: {NaN} at lag [1] SMA: {NaN} at lag [12] Seasonality: 12 Beta: [1×0] Variance: NaN
Modify Model Object
Create the AR(3) model represented by this equation:
$${y}_{t}=0.05+0.6{y}_{t1}+0.2{y}_{t2}0.1{y}_{t3}+{\epsilon}_{t},$$
where $${\epsilon}_{t}$$ is a series of iid Gaussian random variables with mean 0 and variance 0.01.
Mdl = arima('Constant',0.05,'AR',{0.6,0.2,0.1},'Variance',0.01)
Mdl = arima with properties: Description: "ARIMA(3,0,0) Model (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" P: 3 D: 0 Q: 0 Constant: 0.05 AR: {0.6 0.2 0.1} at lags [1 2 3] SAR: {} MA: {} SMA: {} Seasonality: 0 Beta: [1×0] Variance: 0.01
Add a nonseasonal MA term at lag 2 with coefficient 0.2
. Then, display the MA
property.
Mdl.MA = {0 0.2}
Mdl = arima with properties: Description: "ARIMA(3,0,2) Model (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" P: 3 D: 0 Q: 2 Constant: 0.05 AR: {0.6 0.2 0.1} at lags [1 2 3] SAR: {} MA: {0.2} at lag [2] SMA: {} Seasonality: 0 Beta: [1×0] Variance: 0.01
Mdl.MA
ans=1×2 cell array
{[0]} {[0.2000]}
In the model display, lags
indicates the lags to which the corresponding coefficients are associated. Although MATLAB® removes zerovalued coefficients from the display, the properties storing coefficients preserve them.
Change the model constant to 1
.
Mdl.Constant = 1
Mdl = arima with properties: Description: "ARIMA(3,0,2) Model (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" P: 3 D: 0 Q: 2 Constant: 1 AR: {0.6 0.2 0.1} at lags [1 2 3] SAR: {} MA: {0.2} at lag [2] SMA: {} Seasonality: 0 Beta: [1×0] Variance: 0.01
Specify t Distribution for Innovations
Create an AR(1) model template and specify iid $\mathit{t}$distributed innovations with unknown degrees of freedom. Use the longhand syntax.
Mdl = arima('ARLags',1,'Distribution',"t")
Mdl = arima with properties: Description: "ARIMA(1,0,0) Model (t Distribution)" SeriesName: "Y" Distribution: Name = "t", DoF = NaN P: 1 D: 0 Q: 0 Constant: NaN AR: {NaN} at lag [1] SAR: {} MA: {} SMA: {} Seasonality: 0 Beta: [1×0] Variance: NaN
The degrees of freedom DoF
is NaN
, which indicates that the degrees of freedom is estimable.
Create the fully specified AR(1) model represented by this equation:
$${y}_{t}=0.6{y}_{t1}+{\epsilon}_{t},$$
where ${\epsilon}_{\mathit{t}}$ is an iid series of $\mathit{t}$distributed random variables with 10 degrees of freedom. Use the longhand syntax.
innovdist = struct('Name',"t",'DoF',10); Mdl = arima('Constant',0,'AR',{0.6},... 'Distribution',innovdist)
Mdl = arima with properties: Description: "ARIMA(1,0,0) Model (t Distribution)" SeriesName: "Y" Distribution: Name = "t", DoF = 10 P: 1 D: 0 Q: 0 Constant: 0 AR: {0.6} at lag [1] SAR: {} MA: {} SMA: {} Seasonality: 0 Beta: [1×0] Variance: NaN
Create Composite Conditional Mean and Variance Model Template
Create the ARMA(1,1) conditional mean model containing an ARCH(1) conditional variance model represented by these equations:
$$\begin{array}{l}{y}_{t}=c+\varphi {y}_{t1}+{\epsilon}_{t}+\theta {\epsilon}_{t1}.\\ {\epsilon}_{t}={\sigma}_{t}{z}_{t}.\\ {\sigma}_{t}^{2}=\kappa +\gamma {\sigma}_{t1}^{2}.\\ {z}_{t}\sim N(0,1).\end{array}$$
Create the ARMA(1,1) conditional mean model template by using the shorthand syntax.
Mdl = arima(1,0,1)
Mdl = arima with properties: Description: "ARIMA(1,0,1) Model (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" P: 1 D: 0 Q: 1 Constant: NaN AR: {NaN} at lag [1] SAR: {} MA: {NaN} at lag [1] SMA: {} Seasonality: 0 Beta: [1×0] Variance: NaN
The Variance
property of Mdl
is NaN
, which means that the model variance is an unknown constant.
Create the ARCH(1) conditional variance model template by using the shorthand syntax of garch
.
CondVarMdl = garch(0,1)
CondVarMdl = garch with properties: Description: "GARCH(0,1) Conditional Variance Model (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" P: 0 Q: 1 Constant: NaN GARCH: {} ARCH: {NaN} at lag [1] Offset: 0
Create the composite conditional mean and variance model template by setting the Variance
property of Mdl
to CondVarMdl
using dot notation.
Mdl.Variance = CondVarMdl
Mdl = arima with properties: Description: "ARIMA(1,0,1) Model (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" P: 1 D: 0 Q: 1 Constant: NaN AR: {NaN} at lag [1] SAR: {} MA: {NaN} at lag [1] SMA: {} Seasonality: 0 Beta: [1×0] Variance: [GARCH(0,1) Model]
All NaN
valued properties of the conditional mean and variance models are estimable.
Estimate ARIMAX Model
Create an ARMAX(1,2) model for predicting changes in the US personal consumption expenditure based on changes in paid compensation of employees.
Load the US macroeconomic data set.
load Data_USEconModel
DataTimeTable
is a MATLAB® timetable containing quarterly macroeconomic measurements from 1947:Q1 through 2009:Q1. PCEC
is the personal consumption expenditure series, and COE
is the paid compensation of employees series. Both variables are in levels. For more details on the data, enter Description
at the command line.
The series are nonstationary. To avoid spurious regression, stabilize the variables by converting the levels to returns using price2ret
. Compute the sample size.
pcecret = price2ret(DataTimeTable.PCEC); coeret = price2ret(DataTimeTable.COE); T = numel(pcecret);
Because conversion from levels to returns involves applying the first difference, the transformation reduces the total sample size by one observation.
Create an ARMA(1,2) model template using the shorthand syntax.
Mdl = arima(1,0,2);
The exogenous component enters the model during estimation. Therefore, you do not need to set the Beta
property of Mdl
to a NaN
so that estimate
fits the model to the data with the other parameters.
ARMA(1,2) process initialization requires Mdl.P
= 1 observation. Therefore, the presample period is the first time point in the data (first row) and the estimation sample is the rest of the data. Specify variables identifying the presample and estimation periods.
idxpre = Mdl.P; idxest = (Mdl.P + 1):T;
Fit the model to the data. Specify the presample by using the 'Y0'
namevalue pair argument, and specify the exogenous data by using the 'X'
namevalue pair argument.
EstMdl = estimate(Mdl,pcecret(idxest),'Y0',pcecret(idxpre),... 'X',coeret(idxest));
ARIMAX(1,0,2) Model (Gaussian Distribution): Value StandardError TStatistic PValue _________ _____________ __________ __________ Constant 0.0091866 0.001269 7.239 4.5203e13 AR{1} 0.13506 0.081986 1.6474 0.099478 MA{1} 0.090445 0.082052 1.1023 0.27034 MA{2} 0.29671 0.064589 4.5939 4.3505e06 Beta(1) 0.5831 0.048884 11.928 8.4532e33 Variance 5.305e05 3.1387e06 16.902 4.358e64
All estimates, except the lag 1 MA coefficient, are significant at 0.1 level.
Display EstMdl
.
EstMdl
EstMdl = arima with properties: Description: "ARIMAX(1,0,2) Model (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" P: 1 D: 0 Q: 2 Constant: 0.00918662 AR: {0.135063} at lag [1] SAR: {} MA: {0.0904451 0.296714} at lags [1 2] SMA: {} Seasonality: 0 Beta: [0.583095] Variance: 5.30503e05
Like Mdl
, EstMdl
is an arima
model object representing an ARMA(1,2) process. Unlike Mdl
, EstMdl
is fully specified because it is fit to the data, and EstMdl
contains an exogenous component, so it is an ARMAX(1,2) model.
Simulate ARIMA Model
Create an arima
model object for the random walk represented in this equation:
$${y}_{t}={y}_{t1}+{\epsilon}_{t},$$
where ${\epsilon}_{\mathit{t}}$ is a series of iid Gaussian random variables with mean 0 and variance 1.
Mdl = arima(0,1,0); Mdl.Constant = 0; Mdl.Variance = 1; Mdl
Mdl = arima with properties: Description: "ARIMA(0,1,0) Model (Gaussian Distribution)" SeriesName: "Y" Distribution: Name = "Gaussian" P: 1 D: 1 Q: 0 Constant: 0 AR: {} SAR: {} MA: {} SMA: {} Seasonality: 0 Beta: [1×0] Variance: 1
Mdl
is a fully specified arima
model object.
Simulate and plot 1000 paths of length 100 from the random walk.
rng(1) % For reproducibility Y = simulate(Mdl,100,'NumPaths',1000); plot(Y) title('Simulated Paths from Random Walk Process')
Forecast ARIMA Model
Forecast NASDAQ daily closing prices over a 500day horizon.
Load the US equity indices data set.
load Data_EquityIdx
The data set contains daily NASDAQ closing prices from 1990 through 2001. For more details, enter Description
at the command line.
Assume that an ARIMA(1,1,1) model is appropriate for describing the first 1500 NASDAQ closing prices. Create an ARIMA(1,1,1) model template.
Mdl = arima(1,1,1);
estimate
requires a presample of size Mdl.P
= 2.
Fit the model to the data. Specify the first two observations as a presample.
idxpre = 1:Mdl.P; idxest = (Mdl.P + 1):1500; EstMdl = estimate(Mdl,DataTable.NASDAQ(idxest),... 'Y0',DataTable.NASDAQ(idxpre));
ARIMA(1,1,1) Model (Gaussian Distribution): Value StandardError TStatistic PValue _________ _____________ __________ __________ Constant 0.43291 0.18607 2.3266 0.019989 AR{1} 0.076323 0.082045 0.93026 0.35223 MA{1} 0.31312 0.077284 4.0516 5.0876e05 Variance 27.86 0.63785 43.678 0
Forecast the closing values into a 500day horizon by passing the estimated model to forecast
. To initialize the model for forecasting, specify the last two observations in the estimation data as a presample.
yf0 = DataTable.NASDAQ(idxest(end  1:end)); yf = forecast(EstMdl,500,yf0);
Plot the first 2000 observations and the forecasts.
dates = datetime(dates,'ConvertFrom',"datenum",... 'Format',"yyyyMMdd"); figure h1 = plot(dates(1:2000),DataTable.NASDAQ(1:2000)); hold on h2 = plot(dates(1501:2000),yf,'r'); legend([h1 h2],"Observed","Forecasted",... 'Location',"NorthWest") title("NASDAQ Composite Index: 19900102 – 19971125") xlabel("Time (days)") ylabel("Closing Price") hold off
After the start of 1995, the model forecasts almost always underestimate the true closing prices.
More About
Lag Operator
The lag operator L is defined as $${L}^{i}{y}_{t}={y}_{ti}.$$ Lag operators condense polynomial notation.
Linear Time Series Model
A linear time series model for response process y_{t} and random innovations ε_{t} is a stochastic process in which the current response is a linear function of previous responses, the current and previous innovations, and exogenous covariates x_{t}. In differenceequation notation, the general form of a linear time series model is:
$${y}_{t}=c+{x}_{t}\beta +{a}_{1}{y}_{t1}+\dots +{a}_{w}{y}_{tw}+{\epsilon}_{t}+{b}_{1}{\epsilon}_{t1}+\dots +{b}_{v}{\epsilon}_{tv}.$$
Given w and v, all coefficients are estimable.
Expressed in lag operator notation, the general model form is:
$$a(L){y}_{t}=c+{x}_{t}\beta +b(L){\epsilon}_{t}.$$
The lag operator polynomials in the model are often expressed as products of polynomials for nonseasonal and multiplicative seasonal effects and integration:
$$\varphi (L){(1L)}^{D}\Phi (L){(1{L}^{s})}^{{D}_{s}}{y}_{t}=c+{x}_{t}\beta +\theta (L)\Theta (L){\epsilon}_{t}.$$
Model Component  Description  arima Property 

$$\varphi (L)$$  $$\varphi (L)=1\varphi L{\varphi}_{2}{L}^{2}\mathrm{...}{\varphi}_{p}{L}^{p},$$ a pdegree stable nonseasonal AR polynomial. 

D  Degree of nonseasonal integration  D 
$$\Phi (L)$$  $$\Phi (L)=1{\Phi}_{{p}_{1}}{L}^{{p}_{1}}{\Phi}_{{p}_{2}}{L}^{{p}_{2}}\mathrm{...}{\Phi}_{{p}_{s}}{L}^{{p}_{s}},$$ a p_{s}degree stable, multiplicative seasonal AR polynomial. 

s  Seasonality, or the degree of the seasonal differencing polynomial 

D_{s}  Degree of seasonal integration  No corresponding property, but:

c  Model constant  Constant 
β  Regression coefficient of exogenous covariates  Beta 
$$\theta (L)$$  $$\theta (L)=1+\theta L+{\theta}_{2}{L}^{2}+\mathrm{...}+{\theta}_{q}{L}^{q},$$ a qdegree invertible nonseasonal MA polynomial.  MA stores the coefficients; indices correspond to lag exponents. 
$$\Theta (L)$$  $$\Theta (L)=1+{\Theta}_{{q}_{1}}{L}^{{q}_{1}}+{\Theta}_{{q}_{2}}{L}^{{q}_{2}}+\mathrm{...}+{\Theta}_{{q}_{s}}{L}^{{q}_{s}},$$ a q_{s}degree invertible, multiplicative seasonal MA polynomial.  SMA stores the coefficients; indices correspond to lag exponents. 
ε_{t}  Series of random iid innovations  Distribution stores the distribution name and any parameters. 
The model property
P
is equal to p + D + p_{s} + s.The model property
Q
is equal to q + q_{s}.
Note
The degrees of the lag operators in the seasonal polynomials Φ(L) and Θ(L) do not conform to the degrees defined by Box and Jenkins [1]. In other words, Econometrics Toolbox™ does not treat p_{1} = s, p_{2} = 2s,...,p_{s} = r_{p}s and q_{1} = s, q_{2} = 2s,...,q_{s} = r_{q}s where r_{p} and r_{q} are positive integers. The software is flexible, letting you specify the lag operator degrees. See Create Multiplicative ARIMA Models.
Stationarity
A stochastic process y_{t} is stationary if its expected value, variance, and covariance between elements of the series are independent of time.
For example, the MA(q) model, with c = 0, is stationary for any $$q<\infty $$ because each of the following are free of t for all time points [1].
$$E({y}_{t})=\theta (L)0=0.$$
$$Var({y}_{t})={\sigma}^{2}{\displaystyle \sum _{i=1}^{q}{\theta}_{i}^{2}}.$$
$$Cov({y}_{t},{y}_{ts})=\{\begin{array}{l}{\sigma}^{2}({\theta}_{s}+{\theta}_{1}{\theta}_{s1}+{\theta}_{2}{\theta}_{s2}+\mathrm{...}+{\theta}_{q}{\theta}_{sq})\text{if}s\ge q\\ 0\text{otherwise}.\end{array}$$
Unit Root
The time series $$\{{y}_{t};t=1,\mathrm{...},T\}$$ is a unit root process if its expected value, variance, or covariance grows with time. Consequently, the time series is nonstationary.
References
[1] Box, George E. P., Gwilym M. Jenkins, and Gregory C. Reinsel. Time Series Analysis: Forecasting and Control. 3rd ed. Englewood Cliffs, NJ: Prentice Hall, 1994.
[2] Hamilton, James D. Time Series Analysis. Princeton, NJ: Princeton University Press, 1994.
Version History
Introduced in R2012aR2023b: Name an ARIMA model response series
Name the response series of an ARIMA model by setting the
SeriesName
property to a string scalar. When you supply input
response data to model object functions in a table or timetable, the functions choose the
variable with name SeriesName
as the response variable by default.
R2018a: Describe an ARIMA model
Describe an ARIMA model by setting the Description
property to a
string scalar.
R2018a: Use indices that are consistent with MATLAB cell array indexing
The indices of cell arrays of lag operator polynomial coefficients follow MATLAB^{®} cell array indexing rules. Affected model properties are the
AR
, MA
, SAR
, and
SMA
properties.
You cannot access any lagzero coefficients by using an index of
0
. For example,Mdl.AR{0}
issues an error.Remove any instances of such indices of zero from your code. The value of all lagzero coefficients is
1
, except for the lag operator polynomial corresponding to theARCH
property, which has the value0
.You cannot index beyond the maximal lag in the polynomial. For example, if
Mdl.P
is 4, thenMdl.AR{p}
issues an error whenp
is greater than4
. For details on the maximal lags of the lag operator polynomials, see the corresponding property descriptions.Remove any instances of such indices beyond the maximal lag from your code. All coefficients beyond the maximal lag are
0
.
R2018a: Models store innovation distribution name as a string scalar
The Name
field of the Distribution
property of
arima
model objects stores the innovation distribution name
as a string scalar, for example, "Gaussian"
for Gaussian innovations.
Before R2018a, MATLAB stored the innovation distribution name as a character vector, for example
'Gaussian'
for Gaussian innovations. Although most textdata
operations accept character vectors and string scalars for textdata input, the two data
types have some differences. For details, see Text in String and Character Arrays.
See Also
Apps
Objects
Topics
 Analyze Time Series Data Using Econometric Modeler
 Creating Univariate Conditional Mean Models
 Modify Properties of Conditional Mean Model Objects
 Specify Conditional Mean Model Innovation Distribution
 Create Autoregressive Models
 Create Moving Average Models
 Create Autoregressive Moving Average Models
 Create Autoregressive Integrated Moving Average Models
 Create ARIMA Models That Include Exogenous Covariates
 Create Multiplicative ARIMA Models
 Create Multiplicative Seasonal ARIMA Model for Time Series Data
 Specify Conditional Mean and Variance Models
Open Example
You have a modified version of this example. Do you want to open this example with your edits?
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
 América Latina (Español)
 Canada (English)
 United States (English)
Europe
 Belgium (English)
 Denmark (English)
 Deutschland (Deutsch)
 España (Español)
 Finland (English)
 France (Français)
 Ireland (English)
 Italia (Italiano)
 Luxembourg (English)
 Netherlands (English)
 Norway (English)
 Österreich (Deutsch)
 Portugal (English)
 Sweden (English)
 Switzerland
 United Kingdom (English)