R/LearnerSurv.R

In mlr-org/mlr3survival: Survival Analysis for mlr3

#' @title Survival Learner
#'
#' @usage NULL
#' @format [R6::R6Class] object inheriting from [mlr3::Learner].
#'
#' @description
#' This Learner specializes [mlr3::Learner] for survival problems.
#' The slot `task_type` is set to `"surv"`.
#' Predefined learners can be found in the [mlr3misc::Dictionary] [mlr3::mlr_learners].
#'
#' @section Construction:
#' ```
#' l = LearnerSurv$new(id, param_set = ParamSet$new(), predict_types = character(),
#'      feature_types = character(), properties = character(), packages = character())
#' ```
#' For a description of the arguments, see [mlr3::Learner].
#' `task_type` is set to `"surv"`.
#' Currently only possible value for `predict_types` is "risk".
#'
#' @section Fields:
#' See [mlr3::Learner].
#'
#' @section Methods:
#' See [mlr3::Learner].
#'
#' @family Learner
#' @export
#' @examples
#' library(mlr3)
#' ids = mlr_learners$keys("^surv")
#' lrns = mlr_learners$mget(ids)
#' names(lrns)
#'
#' # get a specific learner from mlr_learners:
#' lrn = mlr_learners$get("surv.rpart")
#' print(lrn)
LearnerSurv = R6Class("LearnerSurv", inherit = Learner,
  public = list(
    initialize = function(id, param_set = ParamSet$new(), predict_types = "risk", feature_types = character(), properties = character(), packages = character()) {
      super$initialize(id = id, task_type = "surv", param_set = param_set, predict_types = predict_types,
        feature_types = feature_types, properties = properties, packages = packages)
    }
  )
)