Time Series Model Package

TSM Object

The TSM object generates forecasts of univariate time series.

Table 17.3 lists the time series model families that are supported.

Table 17.3: Model Families for the TSM Object

Family

Object

Description

ARIMA

ARIMASPEC

ARIMAX models

ESM

ESMSPEC

Exponential smoothing models

EXM

EXMSPEC

External model (external forecast)

IDM

IDMSPEC

Intermittent demand models (Croston’s/average demand (ADEM))

UCM

UCMSPEC

Unobserved component models


Table 17.4 summarizes the methods that are associated with the TSM object.

Table 17.4: Methods of the TSM Object

Method

Description

AddX

Add an independent time series array (XSeries) for the TSM object

AddExternal

Add external forecast component series for the TSM object

criterion

Return the final forecast fit statistic

GetForecast

Get the forecast series

Initialize

Initialize the TSM object

nfor

Return the forecast series length

Replay

Replay the restored model and parameter estimates

Run

Run the TSM object

SetOption

Specify the named option for the TSM object

SetY

Specify the dependent time series array (YSeries) for the TSM object


The basic execution pattern for using a TSM object follows this sequence of operations:

  1. Declare: The object declaration statement creates a new TSM object.

  2. Initialize: The TSM.Initialize method takes a model specification object as its argument and initializes the TSM object for that specified time series model. If no model specification object is provided, the TSM object is initialized as an exponential smoothing method (ESM) that uses the best suited exponential smoothing model. This is equivalent to initializing the TSM object with an ESMSPEC object that has default option values.

  3. SetY: The TSM.SetY method defines the dependent time series for the TSM object.

  4. AddX: The TSM.AddX method defines any independent time series for the TSM object. Each call defines one predictor series. Repeat as needed for each predictor series.

  5. SetOption: The TSM.SetOption method specifies any options that affect the running of the model. Each call defines an option. Repeat as needed to specify all options that are required.

  6. Run: The TSM.Run method uses its currently configured X and Y time series data to execute the time series model that is defined by the TSM object’s model specification. At completion, the model has estimated the parameters and produced a final forecast based on these parameters.

Last updated: June 14, 2018