predict.hyper_gam {hyper.gam}R Documentation

Prediction of hyper_gam Model

Description

Prediction of hyper_gam model.

Usage

## S3 method for class 'hyper_gam'
predict(
  object,
  newdata = object$data,
  sign_adjusted = TRUE,
  sgn = if (sign_adjusted) sign(cor_xy(object, probs = 0.5)) else 1,
  ...
)

Arguments

object

an hyper_gam model

newdata

test hyperframe, with at least the response y^{\text{new}} and the double-hypercolumn X^{\text{new}} tabulated on the same grid as the training hypercolumn X. If missing, the training data object$data will be used.

sign_adjusted

logical scalar, default TRUE

sgn

(internal use) numeric scalar, either -1 or 1, the sign of cor_xy() return, to be used in the sign adjustment

...

additional parameters, currently not in use.

Details

Function predict.hyper_gam() computes the sign-adjusted gam model prediction. The sign-adjustment ensures that the return is positively associated with the training hypercolumn X at the selected tabulating grid.

Value

Function predict.hyper_gam() returns a double vector.


[Package hyper.gam version 0.1.2 Index]