adjust_deg_free: Parameters to adjust effective degrees of freedom

View source: R/param_adjust_reg_free.R

adjust_deg_freeR Documentation

Parameters to adjust effective degrees of freedom

Description

This parameter can be used to moderate smoothness of spline or other terms used in generalized additive models.

Usage

adjust_deg_free(range = c(0.25, 4), trans = NULL)

Arguments

range

A two-element vector holding the defaults for the smallest and largest possible values, respectively. If a transformation is specified, these values should be in the transformed units.

trans

A trans object from the scales package, such as scales::log10_trans() or scales::reciprocal_trans(). If not provided, the default is used which matches the units used in range. If no transformation, NULL.

Details

Used in parsnip::gen_additive_mod().

Examples

adjust_deg_free()

dials documentation built on April 3, 2023, 5:43 p.m.