methods-fitted: Extract GARCH model fitted values

fitted-methodsR Documentation

Extract GARCH model fitted values

Description

Extracts fitted values from a fitted GARCH object.

Details

fitted() is a generic function which extracts fitted values from objects returned by modeling functions. methods(fitted) will show the methods available in the current R session.

The method for "fGARCH" objects extracts the @fitted value slot from an object of class "fGARCH" as returned by the function garchFit.

The class of the returned value depends on the input to the function garchFit who created the object. The returned value is always of the same class as the input object to the argument data in the function garchFit, i.e. if you fit a "timeSeries" object, you will get back from the function fitted also a "timeSeries" object, if you fit an object of class "zoo", you will get back again a "zoo" object. The same holds for a "numeric" vector, for a "data.frame", and for objects of class "ts", "mts".

In contrast, the slot itself returns independent of the class of the data input always a numeric vector, i.e. the function call rslot(object, "fitted") will return a numeric vector.

Methods

Methods for fitted defined in package fGarch:

object = "fGARCH"

Extractor function for fitted values.

Note

(GNB) Contrary to the description of the returned value of the "fGARCH" method, it is always "numeric".

TODO: either implement the documented behaviour or fix the documentation.

Author(s)

Diethelm Wuertz for the Rmetrics R-port

See Also

predict, residuals, garchFit, class fGARCH,

plot

Examples

stopifnot(require("timeSeries"))
## Swiss Pension fund Index -
   x = as.timeSeries(data(LPP2005REC))

## garchFit -
   # Fit LPP40 Bechmark:
   fit = garchFit(LPP40 ~ garch(1, 1), data = 100*x, trace = FALSE)
   fit

## fitted -
   # Fitted values are now a "timeSeries" oject:
   fitted = fitted(fit)
   head(fitted)
   class(fitted)

## slot -
   # The slot contains a numeric Vector:
   fitted = slot(fit, "fitted")
   head(fitted)
   class(fitted)

fGarch documentation built on Nov. 10, 2022, 5:48 p.m.