deviance.GeDS: Deviance method for GeDS, GeDSboost, GeDSgam

View source: R/S3methods.R

deviance.GeDSR Documentation

Deviance method for GeDS, GeDSboost, GeDSgam

Description

Method for the function deviance that allows the user to extract the value of the deviance corresponding to a selected GeDS, GeDSboost or GeDSgam fit from a GeDS-Class, GeDSboost-Class or GeDSgam-Class object.

Usage

## S3 method for class 'GeDS'
deviance(object, n = 3L, ...)

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

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

Arguments

object

the GeDS-class, GeDSboost-class or GeDSgam-class object from which the deviance should be extracted.

n

integer value (2, 3 or 4) specifying the order (= degree + 1) of the GeDS/GeDSboost/GeDSgam fit whose deviance should be extracted. By default 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). They will be ignored, but with a warning.

Details

This is a method for the function deviance. As GeDS-class, GeDSboost-class and GeDSgam-class objects contain three different fits (linear, quadratic and cubic), it is possible to specify the order of the GeDS fit for which the deviance is required via the input argument n.

Value

A numeric value corresponding to the deviance of the selected GeDS/GeDSboost/GeDSgam fit. #'

See Also

deviance for the standard definition; GGeDS for examples.


alattuada/GeDS documentation built on April 26, 2024, 11:36 a.m.