man-roxygen/surv_measure.R

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

#' <% meas = suppressWarnings(get(fullname)$new()) %>
#' <% shortname = ifelse(meas$id == "surv.harrell_c", "surv.cindex", meas$id) %>
#'
#' @include MeasureSurv.R
#' @title <%=title%> Survival Measure
#' @name <%= paste("mlr_measures", shortname, sep = "_")%>
#'
#' @section Dictionary:
#' This [Measure][mlr3::Measure] can be instantiated via the [dictionary][mlr3misc::Dictionary]
#' [mlr_measures][mlr3::mlr_measures] or with the associated sugar function [msr()][mlr3::msr]:
#' ```
#' <%=fullname%>$new(<%= if(exists("pars")) pars %>)
#' mlr_measures$get("<%=shortname%>")
#' msr("<%=shortname%>")
#' ```
#'
#' @section Parameters:
#' `r mlr3misc::rd_info(mlr3::msr("<%= shortname %>")$param_set)`
#' @md
#'
#' @section Meta Information:
#' * Type: `"surv"`
#' * Range: <%= format_range(meas$range) %>
#' * Minimize: `<%=meas$minimize%>`
#' * Required prediction: `<%=meas$predict_type%>`
#'
#' @family survival measures
#' @template seealso_measure