Skip to content

Commit 51dcf99

Browse files
committed
docs: improve example template
1 parent acabec8 commit 51dcf99

25 files changed

+350
-50
lines changed

man-roxygen/example.R

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,17 @@
33
#' <%= sprintf("learner = lrn(\"%s\")", id) %>
44
#' print(learner)
55
#'
6-
#' # available parameters:
7-
#' learner$param_set$ids()
6+
#' # Define a Task
7+
#' task = tsk("usarrests")
8+
#'
9+
#' # Train the learner on the task
10+
#' learner$train(task)
11+
#'
12+
#' # Print the model
13+
#' print(learner$model)
14+
#'
15+
#' # Make predictions for the task
16+
#' prediction = learner$predict(task)
17+
#'
18+
#' # Score the predictions
19+
#' prediction$score(task = task)

man/mlr_learners_clust.MBatchKMeans.Rd

Lines changed: 14 additions & 2 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: 14 additions & 2 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: 14 additions & 2 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: 14 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mlr_learners_clust.bico.Rd

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

man/mlr_learners_clust.birch.Rd

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

man/mlr_learners_clust.cmeans.Rd

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

man/mlr_learners_clust.cobweb.Rd

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

man/mlr_learners_clust.dbscan.Rd

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

0 commit comments

Comments
 (0)