From 0edc3542d0b1735a445c4e8c85e817ad903306fd Mon Sep 17 00:00:00 2001 From: be-marc Date: Wed, 26 Jun 2024 10:05:35 +0200 Subject: [PATCH] docu: links --- R/ResultData.R | 8 ++++---- man/ResultData.Rd | 8 ++++---- man/mlr_learners_classif.debug.Rd | 31 +++---------------------------- 3 files changed, 11 insertions(+), 36 deletions(-) diff --git a/R/ResultData.R b/R/ResultData.R index e6007fd1b..a2c74feb0 100644 --- a/R/ResultData.R +++ b/R/ResultData.R @@ -5,7 +5,7 @@ #' It is advised to not directly work on this data structure as it may be changed in the future #' without further warnings. #' -#' The main motivation of this data structure is the necessity to avoid storing duplicated [R6] objects. +#' The main motivation of this data structure is the necessity to avoid storing duplicated [R6][R6::R6Class] objects. #' While this is usually no problem in a single R session, serialization via [serialize()] (which is #' used in [save()]/[saveRDS()] or during parallelization) leads to objects with unreasonable memory #' requirements. @@ -19,7 +19,7 @@ ResultData = R6Class("ResultData", public = list( #' @field data (`list()`)\cr - #' List of `data.tables()`, arranged in a star schema. + #' List of [data.table::data.table()], arranged in a star schema. #' Do not operate directly on this list. data = NULL, @@ -28,7 +28,7 @@ ResultData = R6Class("ResultData", #' Creates a new instance of this [R6][R6::R6Class] class. #' An alternative construction method is provided by [as_result_data()]. #' - #' @param data ([data.table()] | `NULL`)\cr + #' @param data ([data.table::data.table()]) | `NULL`)\cr #' Do not initialize this object yourself, use [as_result_data()] instead. #' @param store_backends (`logical(1)`)\cr #' If set to `FALSE`, the backends of the [Task]s provided in `data` are @@ -325,7 +325,7 @@ ResultData = R6Class("ResultData", #' @param condition (`character(1)`) #' The condition to extract. One of `"message"`, `"warning"` or `"error"`. #' - #' @return [data.table()]. + #' @return [data.table::data.table()]. logs = function(view = NULL, condition) { .__ii__ = private$get_view_index(view) learner_state = NULL diff --git a/man/ResultData.Rd b/man/ResultData.Rd index 7dc22b2d4..1c75c8998 100644 --- a/man/ResultData.Rd +++ b/man/ResultData.Rd @@ -8,7 +8,7 @@ Internal object to store results in list of data.tables, arranged in a star sche It is advised to not directly work on this data structure as it may be changed in the future without further warnings. -The main motivation of this data structure is the necessity to avoid storing duplicated \link{R6} objects. +The main motivation of this data structure is the necessity to avoid storing duplicated \link[R6:R6Class]{R6} objects. While this is usually no problem in a single R session, serialization via \code{\link[=serialize]{serialize()}} (which is used in \code{\link[=save]{save()}}/\code{\link[=saveRDS]{saveRDS()}} or during parallelization) leads to objects with unreasonable memory requirements. @@ -22,7 +22,7 @@ print(ResultData$new()$data) \if{html}{\out{
}} \describe{ \item{\code{data}}{(\code{list()})\cr -List of \code{data.tables()}, arranged in a star schema. +List of \code{\link[data.table:data.table]{data.table::data.table()}}, arranged in a star schema. Do not operate directly on this list.} } \if{html}{\out{
}} @@ -71,7 +71,7 @@ An alternative construction method is provided by \code{\link[=as_result_data]{a \subsection{Arguments}{ \if{html}{\out{
}} \describe{ -\item{\code{data}}{(\code{\link[=data.table]{data.table()}} | \code{NULL})\cr +\item{\code{data}}{(\code{\link[data.table:data.table]{data.table::data.table()}}) | \code{NULL})\cr Do not initialize this object yourself, use \code{\link[=as_result_data]{as_result_data()}} instead.} \item{\code{store_backends}}{(\code{logical(1)})\cr @@ -466,7 +466,7 @@ The condition to extract. One of \code{"message"}, \code{"warning"} or \code{"er \if{html}{\out{
}} } \subsection{Returns}{ -\code{\link[=data.table]{data.table()}}. +\code{\link[data.table:data.table]{data.table::data.table()}}. } } \if{html}{\out{
}} diff --git a/man/mlr_learners_classif.debug.Rd b/man/mlr_learners_classif.debug.Rd index 2f7aa5cdb..3a0af4977 100644 --- a/man/mlr_learners_classif.debug.Rd +++ b/man/mlr_learners_classif.debug.Rd @@ -42,37 +42,12 @@ lrn("classif.debug") \section{Meta Information}{ -\itemize{ -\item Task type: \dQuote{classif} -\item Predict Types: \dQuote{response}, \dQuote{prob} -\item Feature Types: \dQuote{logical}, \dQuote{integer}, \dQuote{numeric}, \dQuote{character}, \dQuote{factor}, \dQuote{ordered} -\item Required Packages: \CRANpkg{mlr3} -} +\verb{r mlr3misc::rd_info(mlr3::lrn("classif.debug"))} } \section{Parameters}{ -\tabular{lllll}{ - Id \tab Type \tab Default \tab Levels \tab Range \cr - error_predict \tab numeric \tab 0 \tab \tab \eqn{[0, 1]}{[0, 1]} \cr - error_train \tab numeric \tab 0 \tab \tab \eqn{[0, 1]}{[0, 1]} \cr - message_predict \tab numeric \tab 0 \tab \tab \eqn{[0, 1]}{[0, 1]} \cr - message_train \tab numeric \tab 0 \tab \tab \eqn{[0, 1]}{[0, 1]} \cr - predict_missing \tab numeric \tab 0 \tab \tab \eqn{[0, 1]}{[0, 1]} \cr - predict_missing_type \tab character \tab na \tab na, omit \tab - \cr - save_tasks \tab logical \tab FALSE \tab TRUE, FALSE \tab - \cr - segfault_predict \tab numeric \tab 0 \tab \tab \eqn{[0, 1]}{[0, 1]} \cr - segfault_train \tab numeric \tab 0 \tab \tab \eqn{[0, 1]}{[0, 1]} \cr - sleep_train \tab untyped \tab - \tab \tab - \cr - sleep_predict \tab untyped \tab - \tab \tab - \cr - threads \tab integer \tab - \tab \tab \eqn{[1, \infty)}{[1, Inf)} \cr - warning_predict \tab numeric \tab 0 \tab \tab \eqn{[0, 1]}{[0, 1]} \cr - warning_train \tab numeric \tab 0 \tab \tab \eqn{[0, 1]}{[0, 1]} \cr - x \tab numeric \tab - \tab \tab \eqn{[0, 1]}{[0, 1]} \cr - iter \tab integer \tab 1 \tab \tab \eqn{[1, \infty)}{[1, Inf)} \cr - early_stopping \tab logical \tab FALSE \tab TRUE, FALSE \tab - \cr - count_marshaling \tab logical \tab FALSE \tab TRUE, FALSE \tab - \cr - check_pid \tab logical \tab TRUE \tab TRUE, FALSE \tab - \cr -} + +\verb{r mlr3misc::rd_info(mlr3::lrn("classif.debug")$param_set)} } \examples{