Skip to content

Commit 7c16d5a

Browse files
committed
docs: modernise example
1 parent 71ca519 commit 7c16d5a

30 files changed

+227
-163
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Suggests:
4444
Config/testthat/edition: 3
4545
Encoding: UTF-8
4646
Roxygen: list(markdown = TRUE, r6 = TRUE)
47-
RoxygenNote: 7.3.2
47+
RoxygenNote: 7.3.3
4848
Collate:
4949
'LearnerClust.R'
5050
'zzz.R'

R/LearnerClust.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
#' @template param_predict_types
1616
#' @template param_feature_types
1717
#' @template param_learner_properties
18-
#' @template param_data_formats
1918
#' @template param_packages
2019
#' @template param_label
2120
#' @template param_man

man-roxygen/example.R

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,7 @@
1-
<%
2-
lrn = mlr3::lrn(id)
3-
pkgs = setdiff(lrn$packages, c("mlr3", "mlr3cluster"))
4-
if (length(pkgs) == 0L) { pkgs = "mlr3" }
5-
pkgs = paste0(sprintf('requireNamespace("%s")', pkgs), collapse = " && ")
6-
%>
7-
#' @examples
8-
#' if (<%= pkgs %>) {
9-
#' learner = mlr3::lrn("<%= id %>")
10-
#' print(learner)
1+
#' <%= sprintf("@examplesIf mlr3misc::require_namespaces(lrn(\"%s\")$packages, quietly = TRUE)", id) %>
2+
#' # Define the Learner and set parameter values
3+
#' <%= sprintf("learner = lrn(\"%s\")", id) %>
4+
#' print(learner)
115
#'
12-
#' # available parameters:
13-
#' learner$param_set$ids()
14-
#' }
6+
#' # available parameters:
7+
#' learner$param_set$ids()

man-roxygen/param_data_formats.R

Lines changed: 0 additions & 3 deletions
This file was deleted.

man/LearnerClust.Rd

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/TaskClust.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mlr_learners_clust.MBatchKMeans.Rd

Lines changed: 9 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mlr_learners_clust.SimpleKMeans.Rd

Lines changed: 9 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mlr_learners_clust.agnes.Rd

Lines changed: 9 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mlr_learners_clust.ap.Rd

Lines changed: 9 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)