Skip to content

Commit f6b81f1

Browse files
authored
docs: update example doc template (#360)
1 parent d7e72ad commit f6b81f1

21 files changed

+108
-112
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Config/testthat/edition: 3
5656
Encoding: UTF-8
5757
NeedsCompilation: no
5858
Roxygen: list(markdown = TRUE)
59-
RoxygenNote: 7.3.2
59+
RoxygenNote: 7.3.3
6060
Collate:
6161
'aaa.R'
6262
'LearnerClassifCVGlmnet.R'

man-roxygen/example.R

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,29 @@
11
<%
2-
lrn = mlr3::lrn(id)
3-
pkgs = setdiff(lrn$packages, c("mlr3", "mlr3learners"))
2+
learner = mlr3::lrn(id)
3+
task_id = if ("LearnerClassif" %in% class(learner)) "sonar" else "mtcars"
44
%>
5-
#' <% task_id = if ("LearnerClassif" %in% class(lrn(id))) "sonar" else "mtcars" %>
6-
#'
7-
#' @examples
8-
#' if (<%= paste0("requireNamespace(\"", pkgs, "\", quietly = TRUE)", collapse = " && ") %>) {
5+
#' <%= sprintf("@examplesIf mlr3misc::require_namespaces(lrn(\"%s\")$packages, quietly = TRUE)", id) %>
96
#' # Define the Learner and set parameter values
10-
#' <%= sprintf("learner = lrn(\"%s\")", id)%>
7+
#' <%= sprintf("learner = lrn(\"%s\")", id) %>
118
#' print(learner)
129
#'
1310
#' # Define a Task
14-
#' <%= sprintf("task = tsk(\"%s\")", task_id)%>
11+
#' <%= sprintf("task = tsk(\"%s\")", task_id) %>
1512
#'
1613
#' # Create train and test set
17-
#' <%= sprintf("ids = partition(task)")%>
14+
#' ids = partition(task)
1815
#'
1916
#' # Train the learner on the training ids
20-
#' <%= sprintf("learner$train(task, row_ids = ids$train)")%>
17+
#' learner$train(task, row_ids = ids$train)
2118
#'
22-
#' # print the model
19+
#' # Print the model
2320
#' print(learner$model)
2421
#'
25-
#' # importance method
26-
#' if("importance" %in% learner$properties) print(learner$importance)
22+
#' # Importance method
23+
#' if ("importance" %in% learner$properties) print(learner$importance)
2724
#'
2825
#' # Make predictions for the test rows
29-
#' <%= sprintf("predictions = learner$predict(task, row_ids = ids$test)")%>
26+
#' predictions = learner$predict(task, row_ids = ids$test)
3027
#'
3128
#' # Score the predictions
3229
#' predictions$score()
33-
#' }

man/mlr_learners_classif.cv_glmnet.Rd

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

man/mlr_learners_classif.glmnet.Rd

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

man/mlr_learners_classif.kknn.Rd

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

man/mlr_learners_classif.lda.Rd

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

man/mlr_learners_classif.log_reg.Rd

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

man/mlr_learners_classif.multinom.Rd

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

man/mlr_learners_classif.naive_bayes.Rd

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

man/mlr_learners_classif.nnet.Rd

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

0 commit comments

Comments
 (0)