docs: more detail for use_groups

mlr-org · Nov 5, 2024 · 4f540ae · 4f540ae
1 parent cf7bca8
commit 4f540ae
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 5 deletions.
diff --git a/R/PipeOpSubsample.R b/R/PipeOpSubsample.R
@@ -36,8 +36,8 @@
 #' * `stratify` :: `logical(1)`\cr
 #'   Should the subsamples be stratified by target? Initialized to `FALSE`. May only be `TRUE` for [`TaskClassif`][mlr3::TaskClassif] input and if `use_groups = FALSE`.
 #' * `use_groups` :: `logical(1)`\cr
-#'   If `TRUE` and if the [`Task`][mlr3::Task] has a column with role `group`, grouped observations are kept together during subsampling. May only be `TRUE` if `strafiy = FALSE`.
-#'   Initialized to `TRUE`.
+#'  If `TRUE` and if the [`Task`][mlr3::Task] has a column with role `group`, grouped observations are kept together during subsampling. In case of  sampling with
+#  `replace = TRUE`, the group entry of duplicate samples is suffixed (`_1`, `_2`, ...). May only be `TRUE` if `strafiy = FALSE`. Initialized to `TRUE`.
 #' * `replace` :: `logical(1)`\cr
 #'   Sample with replacement? Initialized to `FALSE`.
 #'

diff --git a/man/mlr_pipeops_learner_quantiles.Rd b/man/mlr_pipeops_learner_quantiles.Rd
diff --git a/man/mlr_pipeops_subsample.Rd b/man/mlr_pipeops_subsample.Rd