From 915afd439d2e28fa6a19d3d4fdc0258283fb53cf Mon Sep 17 00:00:00 2001 From: be-marc Date: Fri, 15 Dec 2023 18:24:19 +0100 Subject: [PATCH] docs: global default --- R/ArchiveFSelect.R | 4 ++-- man/ArchiveFSelect.Rd | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/R/ArchiveFSelect.R b/R/ArchiveFSelect.R index 01599d56..bc51a803 100644 --- a/R/ArchiveFSelect.R +++ b/R/ArchiveFSelect.R @@ -159,9 +159,9 @@ ArchiveFSelect = R6Class("ArchiveFSelect", #' Default is all batches. #' @param ties_method (`character(1)`)\cr #' Method to handle ties. - #' If `NULL` (default), the global ties method set during initialization is used. #' Can be one of `n_features`, `first`, `random`. - #' The option `n_features` (default) selects the feature set with the least features. + #' If `NULL` (default), the global ties method set during initialization is used. + #' The default global ties method is `n_features` which selects the feature set with the least features. #' If there are multiple best feature sets with the same number of features, the first one is selected. #' The `first` method returns the first added best feature set. #' The `random` method returns a random feature set from the best feature sets. diff --git a/man/ArchiveFSelect.Rd b/man/ArchiveFSelect.Rd index 859a55b6..485fd1c3 100644 --- a/man/ArchiveFSelect.Rd +++ b/man/ArchiveFSelect.Rd @@ -271,9 +271,9 @@ Default is all batches.} \item{\code{ties_method}}{(\code{character(1)})\cr Method to handle ties. -If \code{NULL} (default), the global ties method set during initialization is used. Can be one of \code{n_features}, \code{first}, \code{random}. -The option \code{n_features} (default) selects the feature set with the least features. +If \code{NULL} (default), the global ties method set during initialization is used. +The default global ties method is \code{n_features} which selects the feature set with the least features. If there are multiple best feature sets with the same number of features, the first one is selected. The \code{first} method returns the first added best feature set. The \code{random} method returns a random feature set from the best feature sets.}