docs: ordering

mlr-org · Apr 6, 2024 · 11cb555 · 11cb555
1 parent 949069b
commit 11cb555
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/R/FilterBoruta.R b/R/FilterBoruta.R
@@ -5,6 +5,10 @@
 #' @description
 #' Filter using the Boruta algorithm for feature selection.
 #' If `keep = "tentative"`, confirmed and tentative features are returned.
+#' Note that there is no ordering in the selected features.
+#' Selected features get a score of 1, deselected features get a score of 0.
+#' The order of selected features is random.
+#' In combination with \CRANpkg{mlr3pipelines}, only the filter criterion `cutoff` makes sense.
 #'
 #' @references
 #' `r format_bib("kursa_2010")`

diff --git a/man/mlr_filters_boruta.Rd b/man/mlr_filters_boruta.Rd