21 `hyper_gam` from `gam`

The examples in Chapter 21 require that the search path contains the following namespaces. See the explanation of the function name conflict in Section 7.3.5.

library(groupedHyperframe)
library(hyper.gam)
# Registered S3 method overwritten by 'pROC':
#   method   from            
#   plot.roc spatstat.explore

Function hyper.gam::hyper_gam() (v0.2.1.20151031) creates an R object of the S3 class 'hyper_gam', which inherits from the S3 class 'gam' (Chapter 17) from package mgcv (Wood 2017, v1.9.4) with an additional attribute,

attr(.,'xname'), a symbol of the hypercolumn name.

Package hyper.gam (v0.2.1.20151031) implements the following S3 methods to the class 'hyper_gam' (Table 21.1),

Table 21.1: S3 methods hyper.gam::*.hyper_gam (v0.2.1.20151031)

	visible	generic	isS4
`contour.hyper_gam`	TRUE	`graphics::contour`	FALSE
`cor_xy.hyper_gam`	TRUE	`hyper.gam::cor_xy`	FALSE
`persp.hyper_gam`	TRUE	`graphics::persp`	FALSE
`predict.hyper_gam`	TRUE	`stats::predict`	FALSE
`sign_adjust.hyper_gam`	TRUE	`hyper.gam::sign_adjust`	FALSE
`update.hyper_gam`	TRUE	`stats::update`	FALSE

21.1 Sign Adjustment

The S3 generic functions hyper.gam::sign_adjust() and hyper.gam::cor_xy() ..

🚧 Rest of this section is under construction. Expected delivery by 2025-12-31.

21.2 Visualization

The S3 methods contour.hyper_gam() and persp.hyper_gam() .. Listing 5.1 ..

🚧 Rest of this section is under construction. Expected delivery by 2025-12-31.

Visualization of the integrand surface (Chapter 5, Equation 5.3) in functions integrandSurface(), persp.hyper_gam() and contour.hyper_gam() is inspired by function mgcv::vis.gam(). Visualization of the integrand paths, as well as their projections on the \((p,q)\)- and \((p,s)\)-plane, is an original idea and design by Tingting Zhan.

21.3 Prediction

The S3 method hyper.gam::predict.hyper_gam() calculates the quantile index predictors of the training and/or test data set, based on the training model m1a (Chapter 5, Listing 5.2). The returned value is a numeric vector.

Function hyper.gam::predict.hyper_gam() is a convenient wrapper and slight modification of the S3 method mgcv::predict.gam(). The use of S3 generic stats::predict(), which is typically for predicted values, could be confusing, but we choose to follow the practice and nomenclature of function mgcv::predict.gam().

21.4 Update

The S3 method update.hyper_gam() …

🚧 Rest of this section is under construction. Expected delivery by 2025-12-31.