man-roxygen/pipeline.R

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

#' @name <%= paste0("mlr_graphs_", id)%>
#' @title <%=title%> Pipeline
#' @description Wrapper around <%=pipeop%> to simplify [Graph][mlr3pipelines::Graph] creation.
#' @param graph_learner (`logical(1)`)\cr
#' If `TRUE` returns wraps the [Graph][mlr3pipelines::Graph] as a
#' [GraphLearner][mlr3pipelines::GraphLearner] otherwise (default) returns as a `Graph`.
#' @section Dictionary:
#' This [Graph][mlr3pipelines::Graph] can be instantiated via the [dictionary][mlr3misc::Dictionary]
#' [mlr_graphs][mlr3pipelines::mlr_graphs] or with the associated sugar function [ppl()][mlr3pipelines::ppl]:
#' ```
#' mlr_graphs$get("<%=id%>")
#' ppl("<%=id%>")
#' ```
#'
#' @return [mlr3pipelines::Graph] or [mlr3pipelines::GraphLearner]
#' @family pipelines
#' @export