Defines functions print.control_parsnip fit_control control_parsnip

Documented in control_parsnip fit_control

#' Control the fit function
#' Options can be passed to the [fit.model_spec()] function that control the output and
#'  computations
#' @param verbosity An integer where a value of zero indicates
#'  that no messages or output should be shown when packages are
#'  loaded or when the model is fit. A value of 1 means that package
#'  loading is quiet but model fits can produce output to the screen
#'  (depending on if they contain their own `verbose`-type
#'  argument). A value of 2 or more indicates that any output should
#'  be seen.
#' @param catch A logical where a value of `TRUE` will evaluate
#'  the model inside of `try(, silent = TRUE)`. If the model fails,
#'  an object is still returned (without an error) that inherits the
#'  class "try-error".
#' @return An S3 object with class "fit_control" that is a named list with the
#' results of the function call
#' @details
#' `fit_control()` is deprecated in favor of `control_parsnip()`.
#' @export
control_parsnip <- function(verbosity = 1L, catch = FALSE) {
  res <- list(verbosity = verbosity, catch = catch)
  res <- check_control(res)
  class(res) <- "control_parsnip"

#' @export
#' @rdname control_parsnip
fit_control <- function(verbosity = 1L, catch = FALSE) {
  control_parsnip(verbosity = verbosity, catch = catch)

#' @export
print.control_parsnip <- function(x, ...) {
  cat("parsnip control object\n")
  if (x$verbosity > 1)
    cat(" - verbose level", x$verbosity, "\n")
  if (x$catch)
    cat(" - fit errors will be caught\n")

Try the parsnip package in your browser

Any scripts or data that you put into this service are public.

parsnip documentation built on July 21, 2021, 5:08 p.m.