print.GeDS: Print method for GeDS, GeDSboost, GeDSgam

View source: R/S3methods.R

print.GeDSR Documentation

Print method for GeDS, GeDSboost, GeDSgam

Description

Method for the generic function print that allows to print on screen the main information related to the fitted predictor model that can be extracted from a GeDS-class, GeDSboost-class or GeDSgam-class object.

Usage

## S3 method for class 'GeDS'
print(x, digits = max(3L, getOption("digits") - 3L), ...)

## S3 method for class 'GeDSboost'
print(x, digits = max(3L, getOption("digits") - 3L), ...)

## S3 method for class 'GeDSgam'
print(x, digits = max(3L, getOption("digits") - 3L), ...)

Arguments

x

the GeDS-class, GeDSboost-class or GeDSgam-class object for which the main information should be printed on screen.

digits

number of digits to be printed.

...

potentially further arguments (required by the definition of the generic function).

Details

This method allows to print on screen basic information related to the fitted predictor model such as the function call, the number of internal knots for the linear GeDS/FGB-GeDS/GAM-GeDS fit and the deviances for the three (linear, quadratic and cubic) fitted predictor models embedded in the GeDSboost-class or GeDSgam-class object.

Value

This function returns (invisibly) the same input object, but adding the slot Print that contains the three sub-slots:

Nknots

the number of internal knots of the linear GeDS/FGB-GeDS/GAM-GeDS fit

Deviances

the deviances of the three (linear, quadratic and cubic) GeDS/FGB-GeDS/GAM-GeDS fits

Call

the call to the function that produced the x object

See Also

print for the standard definition.


alattuada/GeDS documentation built on March 24, 2024, 4:12 p.m.