tscor.cgarch.estimate {tsmarch} | R Documentation |
Correlation Extractor
Description
Extracts the conditional correlation matrices.
Usage
## S3 method for class 'cgarch.estimate'
tscor(object, distribution = TRUE, ...)
## S3 method for class 'cgarch.simulate'
tscor(object, distribution = TRUE, ...)
## S3 method for class 'cgarch.predict'
tscor(object, distribution = TRUE, ...)
## S3 method for class 'dcc.estimate'
tscor(object, distribution = TRUE, ...)
## S3 method for class 'dcc.simulate'
tscor(object, distribution = TRUE, ...)
## S3 method for class 'dcc.predict'
tscor(object, distribution = TRUE, ...)
## S3 method for class 'gogarch.estimate'
tscor(object, distribution = TRUE, ...)
## S3 method for class 'gogarch.predict'
tscor(object, distribution = TRUE, ...)
## S3 method for class 'gogarch.simulate'
tscor(object, distribution = TRUE, ...)
Arguments
object |
an object class from one of the models in the package. |
distribution |
whether to return the full simulated correlation distribution for the predicted and simulated objects, else the average covariance across each horizon. |
... |
none |
Details
Estimation Object
An array of correlation matrices with time as the third dimension. The returned object has attributes ‘index’ representing the datetime and ‘series’ representing the series names.
Simulation and Prediction Objects
A 4-d array of dimensions (n_series x n_series x horizon x n_draws). If
distribution
is FALSE, then the average covariance across all draws, an
array of dimensions (n_series x n_series x horizon).
Value
the correlation (see details).
Author(s)
Alexios Galanos
[Package tsmarch version 1.0.0 Index]