diff --git a/R/FilterBoruta.R b/R/FilterBoruta.R index 4efb636e..536a7475 100644 --- 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 index 14126732..4c7da13c 100644 --- a/man/mlr_filters_boruta.Rd +++ b/man/mlr_filters_boruta.Rd @@ -7,6 +7,10 @@ \description{ Filter using the Boruta algorithm for feature selection. If \code{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 \code{cutoff} makes sense. } \examples{ \donttest{