knots: Knots method for GeDS, GeDSboost, GeDSgam

In alattuada/GeDS: Geometrically Designed Spline Regression

Knots method for GeDS, GeDSboost, GeDSgam

Description

Method for the generic function knots that allows the user to extract the vector of knots of a GeDS, GeDSboost or GeDSgam fit of a specified order contained in a GeDS-class, GeDSboost-class or GeDSgam-class object, respectively.

Usage

## S3 method for class 'GeDS'
knots(Fn, n = 3L, options = c("all", "internal"), ...)

## S3 method for class 'GeDSboost'
knots(Fn, n = 3L, options = c("all", "internal"), ...)

## S3 method for class 'GeDSgam'
knots(Fn, n = 3L, options = c("all", "internal"), ...)

Arguments

Fn	the GeDS-class, GeDSboost-class or GeDSgam-class object from which the vector of knots for the specified GeDS, FGB-GeDS or GAM-GeDS fit should be extracted.
n	integer value (2, 3 or 4) specifying the order (= degree + 1) of the GeDS, FGB-GeDS or GAM-GeDS fit whose knots should be extracted. By default equal to 3L. Non-integer values will be passed to the function as.integer.
options	a character string specifying whether "all" knots, including the left-most and the right-most limits of the interval embedding the observations (the default) or only the "internal" knots should be extracted.
...	potentially further arguments (required for compatibility with the definition of the generic function). Currently ignored, but with a warning.

Details

This is a method for the function knots in the stats package.

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 whose knots are required via the input argument n.

Value

A vector in which each element represents a knot of the GeDS/FGB-GeDS/GAM-GeDS fit of the required order.

See Also

knots for the definition of the generic function; NGeDS, GGeDS, NGeDSboost and NGeDSgam for examples.

alattuada/GeDS documentation built on April 21, 2024, 2:35 p.m.