Merge pull request #618 from tidymodels/deprecate-fit_control

Author: EmilHvitfeldt

NEWS.md

@@ -18,8 +18,11 @@
 
 * The fit time is only calculated when the `verbosity` argument of `control_parsnip()` is 2L or greater. Also, the call to `system.time()` now uses `gcFirst = FALSE`. (#611)
 
+* `fit_control()` is soft-deprecated in favor of `control_parsnip()`. 
+
 * Argument `interval` was added for prediction: For types "survival" and "quantile", estimates for the confidence or prediction interval can be added if available (#615).
 
+
 # parsnip 0.1.7
 
 ## Model Specification Changes

R/control_parsnip.R

@@ -18,23 +18,14 @@
 #' @examples
 #' control_parsnip(verbosity = 2L)
 #'
-#' @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"
   res
 }
 
-#' @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")

R/fit_control.R

@@ -0,0 +1,32 @@
+#' Control the fit function
+#'
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' Pass options to the [fit.model_spec()] function to control its
+#' output and computations
+#'
+#' @param verbosity An integer to control how verbose the output is. For a
+#'  value of zero, no messages or output are shown when packages are loaded or
+#'  when the model is fit. For a value of 1, package loading is quiet but model
+#'  fits can produce output to the screen (depending on if they contain their
+#'  own `verbose`-type argument). For a value of 2 or more, any output at all
+#'  is displayed and the execution time of the fit is recorded and printed.
+#' @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 "control_parsnip" that is a named list
+#' with the results of the function call
+#'
+#' @examples
+#' fit_control(verbosity = 2L)
+#'
+#' @details
+#' `fit_control()` is deprecated in favor of `control_parsnip()`.
+#'
+#' @export
+#' @keywords internal
+fit_control <- function(verbosity = 1L, catch = FALSE) {
+  lifecycle::deprecate_soft("0.1.8", "fit_control()", "control_parsnip()")
+  control_parsnip(verbosity = verbosity, catch = catch)
+}

_pkgdown.yml

@@ -54,7 +54,7 @@ reference:
       - extract-parsnip
       - fit.model_spec
       - fit_xy
-      - fit_control
+      - control_parsnip
       - glance.model_fit
       - model_fit
       - model_spec