coef.GeDSboost_GeDSgam: Coef method for GeDSboost, GeDSgam

View source: R/S3methods_GeDSboost-GeDSgam.R

coef.GeDSboost,gamR Documentation

Coef method for GeDSboost, GeDSgam

Description

Methods for the functions coef and coefficients that allow to extract the estimated coefficients of a GeDSboost-class or GeDSgam-class object.

Usage

## S3 method for class 'GeDSboost'
coef(object, n = 3L, ...)

## S3 method for class 'GeDSboost'
coefficients(object, n = 3L, ...)

## S3 method for class 'GeDSgam'
coef(object, n = 3L, ...)

## S3 method for class 'GeDSgam'
coefficients(object, n = 3L, ...)

Arguments

object

the GeDSboost-class or GeDSgam-class object from which the coefficients should be extracted.

n

integer value (2, 3 or 4) specifying the order (= degree + 1) of the FGB-GeDS/GAM-GeDS fit whose coefficients should be extracted.

  • If n = 2L the piecewise polynomial coefficients of the univariate GeDS base-learners are provided. For bivariate GeDS base-learners, and if class(object) == "GeDSboost", the B-spline coefficients for each iteration where the corresponding bivariate base-learner was selected are provided. For bivariate base-learners, and if class(object) == "GeDSgam", the final local-scoring B-spline coefficients are provided.

  • If n = 3L or n = 4L B-spline coefficients are provided for both univariate and bivariate GeDS learners.

By default n is equal to 3L. Non-integer values will be passed to the function as.integer.

...

potentially further arguments (required by the definition of the generic function). These will be ignored, but with a warning.

Value

A named vector containing the required coefficients of the fitted multivariate predictor model.

See Also

coef for the standard definition; NGeDSboost and NGeDSgam for examples.


GeDS documentation built on April 4, 2025, 3:38 a.m.