Skip to contents

Calls penalized::penalized from package penalized.

Details

The penalized and unpenalized arguments in the learner are implemented slightly differently than in penalized::penalized(). Here, there is no parameter for penalized but instead it is assumed that every variable is penalized unless stated in the unpenalized parameter, see examples.

Dictionary

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

mlr_learners$get("surv.penalized")
lrn("surv.penalized")

Meta Information

  • Task type: “surv”

  • Predict Types: “distr”, “crank”

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

  • Required Packages: mlr3extralearners, penalized, pracma

Parameters

IdTypeDefaultLevelsRange
unpenalizedlist-\((-\infty, \infty)\)
lambda1list0\((-\infty, \infty)\)
lambda2list0\((-\infty, \infty)\)
positivelogicalFALSETRUE, FALSE\((-\infty, \infty)\)
fusedllogicalFALSETRUE, FALSE\((-\infty, \infty)\)
startbetanumeric-\((-\infty, \infty)\)
startgammanumeric-\((-\infty, \infty)\)
stepsinteger1\([1, \infty)\)
epsilonnumeric1e-10\([0, 1]\)
maxiterinteger-\([1, \infty)\)
standardizelogicalFALSETRUE, FALSE\((-\infty, \infty)\)
tracelogicalTRUETRUE, FALSE\((-\infty, \infty)\)

References

Goeman JJ (2009). “L1Penalized Estimation in the Cox Proportional Hazards Model.” Biometrical Journal doi: 10.1002/bimj.200900028.

See also

Author

RaphaelS1

Super classes

mlr3::Learner -> mlr3proba::LearnerSurv -> LearnerSurvPenalized

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

LearnerSurvPenalized$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

if (requireNamespace("penalized", quietly = TRUE) && requireNamespace("pracma", quietly = TRUE)) {
  learner = mlr3::lrn("surv.penalized")
  print(learner)

  # available parameters:
  learner$param_set$ids()
}
#> <LearnerSurvPenalized:surv.penalized>
#> * Model: -
#> * Parameters: list()
#> * Packages: mlr3, mlr3extralearners, penalized, pracma
#> * Predict Type: distr
#> * Feature types: integer, numeric, factor, logical
#> * Properties: -
#>  [1] "unpenalized" "lambda1"     "lambda2"     "positive"    "fusedl"     
#>  [6] "startbeta"   "startgamma"  "steps"       "epsilon"     "maxiter"    
#> [11] "standardize" "trace"