varma#

swordfish.function.varma()#

Analyze multivariate time series using a Vector Autoregressive Moving-Average (VARMA) model. It returns a dictionary containing the analysis results.

Parameters:

  • ds (Constant) – An in-memory table or a DATASOURCE vector containing the multivariate time series to be analyzed. ds cannot be empty. Only if the first column of the data source is a time column, the model will automatically sort the data based on the column.

  • endogColNames (Constant) – A STRING vector indicating the column names of the endogenous variables in ds.

  • order (Constant) – A vector with two non-negative integers indicating the number of autoregressive (AR) and moving average (MA) parameters to use.

  • exog (Constant, optional) – A numeric matrix representing exogenous variables except the endogenous time series, by default DFLT. Each column of the matrix represents the time series data of an exogenous variable, and the number of rows must equal the number of rows in ds.

  • trend (Constant, optional) –

    A string indicating the constant and trend order used in the regression, by default DFLT. Possible values:

    • ”c” (default) - add constant

    • ”ct” - constant and treand

    • ”ctt” - constant, linear, and quadratic trend

    • ”n” - no constant or trend

  • errorCovType (Constant, optional) –

    A STRING scalar specifying the structure of the error term’s covariance matrix, by default DFLT. Possible values:

    • ’unstructured’ (default): Preserve the lower triangular part of the covariance matrix

    • ’diagonal’: Preserve only the diagonal part

  • measurementError (Constant, optional) – A boolean scalar indicating whether to assume the endogenous observations were measured with error, by default DFLT.

  • enforceStationarity (Constant, optional) – A boolean scalar indicating whether to transform AR parameters to enforce stationarity in the autoregressive component of the model, by default DFLT.

  • enforceInvertibility (Constant, optional) – A boolean scalar indicating whether to transform MA parameters to enforce invertibility in the moving average component of the model, by default DFLT.

  • trendOffset (Constant, optional) – A positive representing the offset at which time trend values start, by default DFLT.

  • maxIter (Constant, optional) – A positive integer indicating the maximum number of iterations during fitting, by default DFLT.

Returns:

A dictionary containing the following keys:

  • params: A floating matrix of estimated parameters for the VARMA model.

  • kAr: An integer representing the order of the vector autoregressive process.

  • kMa: An integer representing the order of the vector moving average part.

  • kTrend: An integer representing the number of trend terms in the VARMA model.

  • nobs: An integer representing the number of observations in the input multivariate time series.

  • aic: A floating-point number representing the Akaike Information Criterion.

  • bic: A floating-point number representing the Bayesian Information Criterion.

  • hqic: A floating-point number representing the Hannan-Quinn Information Criterion.

  • llf: A floating-point number representing the log-likelihood value of the VARMA model.

Return type:

Constant

On this page