intubate (version 1.0.0)

fGarch: Interfaces for fGarch package for data science pipelines.

Description

Interfaces to fGarch functions that can be used in a pipeline implemented by magrittr.

Usage

ntbt_garchFit(data, ...)

Arguments

data

data frame, tibble, list, ...

...

Other arguments passed to the corresponding interfaced function.

Value

Object returned by interfaced function.

Details

Interfaces call their corresponding interfaced function.

Examples

## Not run: 
# library(intubate)
# library(magrittr)
# library(fGarch)
# 
# 
# ## ntbt_garchFit: Univariate GARCH Time Series Fitting
# N <- 200
# x.vec <- as.vector(garchSim(garchSpec(rseed = 1985), n = N)[,1])
# 
# ## Original function to interface
# garchFit(~ garch(1,1), data = x.vec, trace = FALSE)
# 
# ## The interface puts data as first parameter
# ntbt_garchFit(data = x.vec, ~ garch(1,1), trace = FALSE)
# 
# ## so it can be used easily in a pipeline.
# x.vec %>%
#   ntbt_garchFit(~ garch(1,1), trace = FALSE)
# ## End(Not run)