Adds documentation about racing metrics (#128)

* Fixes #113

* updated tests (due to RNG differences)

* small updates

---------

Co-authored-by: Frans van Dunné <frans@ixpantia.com>
Co-authored-by: ‘topepo’ <mxkuhn@gmail.com>

Author: 3 people

R/tune_race_anova.R

@@ -19,7 +19,8 @@
 #'  data frame should have columns for each parameter being tuned and rows for
 #'  tuning parameter candidates. An integer denotes the number of candidate
 #'  parameter sets to be created automatically.
-#' @param metrics A [yardstick::metric_set()] or `NULL`.
+#' @param metrics A [yardstick::metric_set()] or `NULL`. The first metric in
+#' metrics is the one that will be optimized.
 #' @param eval_time A numeric vector of time points where dynamic event time
 #' metrics should be computed (e.g. the time-dependent ROC curve, etc). The
 #' values must be non-negative and should probably be no greater than the

R/tune_race_win_loss.R

@@ -51,8 +51,9 @@
 #'  statistical analysis is updated. More candidate parameters may be excluded
 #'  with each new resample that is processed.
 #'
-#' The [control_race()] function contains are parameter for the significance cutoff
+#' The [control_race()] function contains parameters for the significance cutoff
 #'  applied to the Bradley-Terry model results as well as other relevant arguments.
+#'  The first metric in the `metrics` argument is the one that will be optimized.
 #'
 #' ## Censored regression models
 #'

inst/WORDLIST

@@ -5,6 +5,7 @@ Codecov
 Lifecycle
 ORCID
 PBC
+ROR
 Technometrics
 doi
 dplyr
@@ -18,4 +19,3 @@ suboptimal
 tibble
 tidymodels
 unsummarized
-wc

man/tune_race_anova.Rd

@@ -89,6 +89,7 @@ test_that("one player is really bad", {
     add_model(rf_spec)
 
   grid <- tibble(trees = c(1, 200))
+
   ctrl <- control_race(burn_in = 2, alpha = .05, randomize = TRUE)
   set.seed(3355)
   tuning_results <- tune_race_win_loss(