Document logging (#1068)

* tune_log() -> update_printer()

* add overview to logging.R and reorganize functions

Author: EmilHvitfeldt

R/checks.R

@@ -170,7 +170,7 @@ check_parameters <- function(wflow, pset = NULL, data, grid_names = character(0)
       cli::format_inline(
         "Creating pre-processing data to finalize {num_unk} unknown parameter{?s}: {.val {unk_names}}")
 
-    tune_log(list(verbose = TRUE), split_labels = NULL, task = msg, type = "info")
+    update_printer(list(verbose = TRUE), split_labels = NULL, task = msg, type = "info")
 
     x <- workflows::.fit_pre(wflow, data)$pre$mold$predictors
     pset$object <- purrr::map(pset$object, dials::finalize, x = x)
@@ -416,7 +416,7 @@ check_initial <- function(x,
     if (ctrl$verbose) {
       message()
       msg <- cli::format_inline(" Generating a set of {nrow(x)} initial parameter results")
-      tune_log(ctrl, split_labels = NULL, task = msg, type = "go")
+      update_printer(ctrl, split_labels = NULL, task = msg, type = "go")
     }
 
     grid_ctrl <- ctrl
@@ -432,7 +432,7 @@ check_initial <- function(x,
     )
 
     if (ctrl$verbose) {
-      tune_log(ctrl, split_labels = NULL, task = "Initialization complete", type = "success")
+      update_printer(ctrl, split_labels = NULL, task = "Initialization complete", type = "success")
       message()
     }
   } else {

R/grid_performance.R

@@ -43,15 +43,15 @@ metrics_info <- function(x) {
 #' @param event_level A logical passed from the control function.
 #' @param x A character vector of package names.
 #' @param .expr Code to execute.
-#' @param ... Object to pass to the internal `tune_log()` function.
+#' @param ... Object to pass to the internal `update_printer()` function.
 #' @param bad_only A logical for whether warnings and errors should be caught.
 #' @param notes Character data to add to the logging.
 #' @param workflow A workflow.
 #' @param grid_preprocessor A tibble with parameter information.
 #' @param new_data A data frame or matrix of predictors to process.
 #' @param metrics_info The output of `tune:::metrics_info(metrics)`---only
 #' included as an argument to allow for pre-computing.
-#' @param catalog A logical passed to `tune_log()` giving whether the message
+#' @param catalog A logical passed to `update_printer()` giving whether the message
 #' is compatible with the issue cataloger. Defaults to `TRUE`. Updates that are
 #' always unique and do not represent a tuning "issue" can bypass the cataloger
 #' by setting `catalog = FALSE`.