order_poly {deseats}R Documentation

Smoothing Option Generics

Description

Various generics that can be used write methods to either retrieve or set smoothing options.

Usage

order_poly(object)

order_poly(object) <- value

season(object, ...)

season(object) <- value

kernel_fun(object)

kernel_fun(object) <- value

bwidth(object)

bwidth(object) <- value

boundary_method(object)

boundary_method(object) <- value

Arguments

object

an object from which to either retrieve options or in which to set an option.

value

the value to set the corresponding option to.

...

without use; implemented for possible future compatibility only.

Details

order_poly, season, kernel_fun, bwidth, and boundary_method can be used to retrieve the order of polynomial, the seasonal frequency, the kernel function setting, the bandwidth and the boundary method from an object with smoothing options. The corresponding generics beginning with <- are useful to set such options instead.

The generics themselves are without a direct purpose.

Generics that can be extended by methods to set or obtain settings (e.g. smoothing options) in certain objects.

Value

These generics do not return anything and are just the basis for more sophisticated methods.


[Package deseats version 1.1.0 Index]