mlr_learners_surv.penalized: Survival L1 and L2 Penalized Regression Learner

In mlr-org/mlr3extralearners: Extra Learners For mlr3

Survival L1 and L2 Penalized Regression Learner

Description

Penalized (L1 and L2) generalized linear models. Calls penalized::penalized() from 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: “crank”, “distr”

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

• Required Packages: mlr3, mlr3proba, mlr3extralearners, penalized, pracma

Parameters

Id	Type	Default	Levels	Range
unpenalized	untyped	-		-
lambda1	untyped	0		-
lambda2	untyped	0		-
positive	logical	FALSE	TRUE, FALSE	-
fusedl	logical	FALSE	TRUE, FALSE	-
startbeta	numeric	-		(-\infty, \infty)
startgamma	numeric	-		(-\infty, \infty)
steps	integer	1		[1, \infty)
epsilon	numeric	1e-10		[0, 1]
maxiter	integer	-		[1, \infty)
standardize	logical	FALSE	TRUE, FALSE	-
trace	logical	TRUE	TRUE, FALSE	-

Super classes

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

Methods

Public methods

• LearnerSurvPenalized$new()

• LearnerSurvPenalized$clone()

Inherited methods

• mlr3::Learner$base_learner()
• mlr3::Learner$format()
• mlr3::Learner$help()
• mlr3::Learner$predict()
• mlr3::Learner$predict_newdata()
• mlr3::Learner$print()
• mlr3::Learner$reset()
• mlr3::Learner$train()

---

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.

Author(s)

RaphaelS1

References

Goeman, J J (2010). “L1 penalized estimation in the Cox proportional hazards model.” Biometrical journal, 52(1), 70–84.

See Also

• Dictionary of Learners: mlr3::mlr_learners.

• as.data.table(mlr_learners) for a table of available Learners in the running session (depending on the loaded packages).

• Chapter in the mlr3book: https://mlr3book.mlr-org.com/basics.html#learners

• mlr3learners for a selection of recommended learners.

• mlr3cluster for unsupervised clustering learners.

• mlr3pipelines to combine learners with pre- and postprocessing steps.

• mlr3tuning for tuning of hyperparameters, mlr3tuningspaces for established default tuning spaces.

Examples

learner = mlr3::lrn("surv.penalized")
print(learner)

# available parameters:
learner$param_set$ids()

mlr-org/mlr3extralearners documentation built on April 13, 2024, 5:25 a.m.