MSGARCH (version 0.17.7)

cdf: Cumulative function.

Description

Method returning the cumulative function in-sample or of a vector of points at t = T + 1.

Usage

cdf(object, x, theta, y, log = FALSE, do.its = FALSE)

Arguments

object

Model specification of class MSGARCH_SPEC created with create.spec or fit object of type MSGARCH_MLE_FIT created with fit.mle or MSGARCH_BAY_FIT created with fit.bayes.

x

Vector (of size N) of point at t = T + 1 to be evaluated (used when do.its = FALSE).

theta

Vector (of size d) or matrix (of size M x d) of parameter estimates (not require when using a fit object).

y

Vector (of size T) of observations (not require when using a fit object).

log

Boolean indicating if the log cumulative is returned. (Default: log = FALSE)

do.its

Boolean indicating if the in-sample cdf is returned. (Default: do.its = FALSE)

Value

A list of class MSGARCH_CDF containing two components:

• cdf: If do.its = FALSE: (Log-)Cumulative of the points x at t = T + 1 (vector of size N or matrix of size M x N). If do.its = TRUE: In-sample (Log-)Cumulative of y (vector of size T or matrix of size M x T).
• x: If do.its = FALSE: Vector (of size N) of point at t = T + 1 evaluated. If do.its = TRUE: Vector (of size T) of observations.

The class MSGARCH_CDF contains the plot method only if do.its = FALSE.

Details

If a matrix of parameter estimates is given, each parameter estimates is evaluated individually. If do.its = FALSE, the points x are evaluated as t = T + 1 realization and the method uses the variance estimate at t = T + 1. If do.its = TRUE, y is evaluated using their respective variance estimate at each time t.

Examples

# load data 
data("sp500")
sp500 = sp500[1:1000]

# create model specification
spec = MSGARCH::create.spec() 

# fit the model on the data with ML estimation using DEoptim intialization
set.seed(123)
fit = MSGARCH::fit.mle(spec = spec, y = sp500, ctr = list(do.init = FALSE))

# run pdf method in-sample
cdf.its = MSGARCH::cdf(object = fit, log = FALSE, do.its = TRUE)

# create mesh
x = seq(-3,3,0.01)

# run cdf method on mesh at T + 1
cdf = MSGARCH::cdf(object = fit, x = x, log = FALSE, do.its = FALSE)

plot(cdf)