man-roxygen/surv_learner.R

In mlr-org/mlr3proba: Probabilistic Supervised Learning for 'mlr3'

#' <% crank_distr_str = "* `crank` is predicted as the sum of the cumulative
#' hazard function (expected mortality) derived from the survival distribution,
#' `distr`" %>
#' <% crank_lp_str = "* `crank` is identical to `lp`" %>
#' <% crank_str = "* crank is predicted " %>
#' <% lp_str = "* lp is predicted " %>
#' <% distr_str = "* distr is predicted " %>
#'
#' <% learn = get(fullname)$new() %>
#' <% shortname = learn$id %>
#'
#' @title <%=title%> Survival Learner
#' @name <%= paste("mlr_learners", shortname, sep = "_")%>
#' @description
#' Calls <%=caller%>.
#'
#' <%= if(exists("lp")) paste0(lp_str, lp) %>
#' <%= if(exists("distr")) paste0(distr_str, distr) %>
#' <%= if(exists("crank")) paste0(crank_str, crank) %>
#' <%= if(!exists("crank") & exists("lp")) crank_lp_str %>
#' <%= if(!exists("crank") & !exists("lp")) crank_distr_str %>
#'
#' @section Dictionary:
#' This [Learner][mlr3::Learner] can be instantiated via the [dictionary][mlr3misc::Dictionary]
#' [mlr_learners][mlr3::mlr_learners] or with the associated sugar function [lrn()][mlr3::lrn]:
#' ```
#' <%=fullname%>$new()
#' mlr_learners$get("<%=shortname%>")
#' lrn("<%=shortname%>")
#' ```
#'
#' @section Meta Information:
#' `r paste(mlr3misc::rd_info(mlr3::lrn("<%= id %>")), collapse = "\n")`
#' @md
#'
#' @section Parameters:
#' `r paste(mlr3misc::rd_info(mlr3::lrn("<%= id %>")$param_set), collapse = "\n")`
#' @md
#'
#' @family survival learners
#' @template seealso_learner