Time Series Model Package
TSMFOR Methods
TSMFOR.Collect Method
rc=obj.Collect (ModelObj <,Region>);
Collects the forecast series from a TSM object, ModelObj. An optional Region argument can be specified to indicate the forecast region to be collected. If you specify the 'SMOOTH' option in the declaration of the TSMFOR instance, then the smoothed (imputed) dependent series is collected instead.
Input Arguments
You must specify the following input argument:
- ModelObj
is a character string that specifies the name of the TSM object to use as the source of time series model forecasts.
You can also specify the following input argument:
- Region
-
specifies the time region over which to collect the forecast series. You can specify the following values for Region:
- string
-
specifies the collection region. You can specify the following strings:
- ALL
collects over the entire time span of the available data.
- FIT
collects over the time region that supplied observations to estimate model parameters (that is, the model fit region).
- FORECAST
collects over the time region that is subsequent to the FIT region and that did not contribute any data to the model parameter estimation process (that is, the model forecast region).
The default is ALL.
- numeric
is a two-valued numeric array, in which the first value specifies the starting time ID and the second value specifies the ending time ID of the time region over which the forecast series are to be collected. Either the starting time ID or the ending time ID can be a missing value. If both are missing values, then the default value ALL is used.
TSMFOR.nrows Method
rc=obj.nrows ();
Returns the number of rows that have been collected and stored in the table.
Arguments
There are no arguments associated with this method.
TSMFOR.SetOption Method
rc=obj.SetOption ('Name', Value);
Specifies the named options for the TSMFOR instance.
Input Arguments
You must specify the following 'Name' and its associated Value:
- 'MODELNAME'
takes a string Value that is copied to the _MODEL_ column of the output table. This option is relevant only if you set the 'MODELNAME' option to 'YES' in the declaration of the TSMFOR instance. The default value is the TSM instance name.