mlr_learners_surv.penalized: Survival L1 and L2 Penalized Regression Learner

Description Details Dictionary Super classes Methods References See Also Examples

Description

A mlr3proba::LearnerSurv implementing penalized from package penalized. Calls penalized::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():

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

Super classes

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

Methods

Public methods

Inherited methods

Method new()

Creates a new instance of this R6 class.

Usage
LearnerSurvPenalized$new()

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.

References

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

See Also

Dictionary of Learners: mlr3::mlr_learners

Examples

1
2
3
4
5
6
7
if (requireNamespace("penalized")) {
  learner = mlr3::lrn("surv.penalized")
  print(learner)

  # available parameters:
  learner$param_set$ids()
}

mlr3learners/mlr3learners.penalized documentation built on Aug. 4, 2020, 5:19 a.m.