Skip to contents

Calls earth::earth from package earth.

Details

Methods for variance estimations are not yet implemented.

Dictionary

This Learner can be instantiated via the dictionary mlr_learners or with the associated sugar function lrn():

mlr_learners$get("regr.earth")
lrn("regr.earth")

Meta Information

  • Task type: “regr”

  • Predict Types: “response”, “se”

  • Feature Types: “numeric”, “factor”, “integer”

  • Required Packages: mlr3extralearners, earth

Parameters

IdTypeDefaultLevelsRange
wplistNULL\((-\infty, \infty)\)
offsetlistNULL\((-\infty, \infty)\)
keepxylogicalFALSETRUE, FALSE\((-\infty, \infty)\)
tracecharacter00, .3, .5, 1, 2, 3, 4, 5\((-\infty, \infty)\)
degreeinteger1\([1, \infty)\)
penaltynumeric2\([-1, \infty)\)
nklistNULL\((-\infty, \infty)\)
threshnumeric0.001\((-\infty, \infty)\)
minspannumeric0\([0, \infty)\)
endspannumeric0\([0, \infty)\)
newvar.penaltynumeric0\([0, \infty)\)
fast.kinteger20\([0, \infty)\)
fast.betainteger1\([0, 1]\)
linpredslistFALSE\((-\infty, \infty)\)
allowedlist-\((-\infty, \infty)\)
pmethodcharacterbackwardbackward, none, exhaustive, forward, seqrep, cv\((-\infty, \infty)\)
npruneinteger-\([0, \infty)\)
nfoldinteger0\([0, \infty)\)
ncrossinteger1\([0, \infty)\)
stratifylogicalTRUETRUE, FALSE\((-\infty, \infty)\)
varmod.methodcharacternonenone, const, lm, rlm, earth, gam, power, power0, x.lm, x.rlm, ...\((-\infty, \infty)\)
varmod.exponentnumeric1\((-\infty, \infty)\)
varmod.convnumeric1\([0, 1]\)
varmod.clampnumeric0.1\((-\infty, \infty)\)
varmod.minspannumeric-3\((-\infty, \infty)\)
Scale.ylogicalFALSETRUE, FALSE\((-\infty, \infty)\)
Adjust.endspannumeric2\((-\infty, \infty)\)
Auto.linpredslogicalTRUETRUE, FALSE\((-\infty, \infty)\)
Force.weightslogicalFALSETRUE, FALSE\((-\infty, \infty)\)
Use.beta.cachelogicalTRUETRUE, FALSE\((-\infty, \infty)\)
Force.xtx.prunelogicalFALSETRUE, FALSE\((-\infty, \infty)\)
Get.leverageslogicalTRUETRUE, FALSE\((-\infty, \infty)\)
Exhaustive.tolnumeric1e-10\((-\infty, \infty)\)

References

Stephen Milborrow (2014) Earth: multivariate adaptive regression spline models R package version 3 https://cran.r-project.org/web/packages/earth/earth.pdf

Jerome H. Friedman (1991) Multivariate Adaptive Regression Splines The Annals of Statistics https://projecteuclid.org/download/pdf_1/euclid.aos/1176347963

See also

Author

pkopper

Super classes

mlr3::Learner -> mlr3::LearnerRegr -> LearnerRegrEarth

Methods

Inherited methods


Method new()

Creates a new instance of this R6 class.

Usage


Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerRegrEarth$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

if (requireNamespace("earth", quietly = TRUE)) {
  learner = mlr3::lrn("regr.earth")
  print(learner)

  # available parameters:
  learner$param_set$ids()
}
#> <LearnerRegrEarth:regr.earth>
#> * Model: -
#> * Parameters: list()
#> * Packages: mlr3, mlr3extralearners, earth
#> * Predict Type: response
#> * Feature types: numeric, factor, integer
#> * Properties: weights
#>  [1] "wp"              "offset"          "keepxy"          "trace"          
#>  [5] "degree"          "penalty"         "nk"              "thresh"         
#>  [9] "minspan"         "endspan"         "newvar.penalty"  "fast.k"         
#> [13] "fast.beta"       "linpreds"        "allowed"         "pmethod"        
#> [17] "nprune"          "nfold"           "ncross"          "stratify"       
#> [21] "varmod.method"   "varmod.exponent" "varmod.conv"     "varmod.clamp"   
#> [25] "varmod.minspan"  "Scale.y"         "Adjust.endspan"  "Auto.linpreds"  
#> [29] "Force.weights"   "Use.beta.cache"  "Force.xtx.prune" "Get.leverages"  
#> [33] "Exhaustive.tol"