Make surv_reg() defunct and update NEWS (#1294)

* Make surv_reg() defunct and update NEWS

* Apply suggestions from code review

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* redoc and remove surv_reg tests

---------

Co-authored-by: Max Kuhn <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: 3 people

DESCRIPTION

@@ -80,4 +80,4 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3

NEWS.md

@@ -1,5 +1,7 @@
 # parsnip (development version)
 
+* `surv_reg()` is now defunct and will error if called. Please use `survival_reg()` instead (#1206).
+
 # parsnip 1.3.3
 
 * Bug fix in how tunable parameters were configured for brulee neural networks. 

R/surv_reg.R

@@ -27,32 +27,37 @@
 #' @keywords internal
 #' @export
 surv_reg <- function(mode = "regression", engine = "survival", dist = NULL) {
+  lifecycle::deprecate_stop("1.4.0", "surv_reg()", "survival_reg()")
 
-  lifecycle::deprecate_warn("0.1.6", "surv_reg()", "survival_reg()")
-
-    args <- list(
-      dist = enquo(dist)
-    )
-
-    new_model_spec(
-      "surv_reg",
-      args = args,
-      eng_args = NULL,
-      mode = mode,
-      user_specified_mode = !missing(mode),
-      method = NULL,
-      engine = engine,
-      user_specified_engine = !missing(engine)
-    )
-  }
+  args <- list(
+    dist = enquo(dist)
+  )
 
+  new_model_spec(
+    "surv_reg",
+    args = args,
+    eng_args = NULL,
+    mode = mode,
+    user_specified_mode = !missing(mode),
+    method = NULL,
+    engine = engine,
+    user_specified_engine = !missing(engine)
+  )
+}
+
+# nocov
 # ------------------------------------------------------------------------------
 
 #' @method update surv_reg
 #' @rdname parsnip_update
 #' @export
-update.surv_reg <- function(object, parameters = NULL, dist = NULL, fresh = FALSE, ...) {
-
+update.surv_reg <- function(
+  object,
+  parameters = NULL,
+  dist = NULL,
+  fresh = FALSE,
+  ...
+) {
   args <- list(
     dist = enquo(dist)
   )
@@ -84,14 +89,13 @@ translate.surv_reg <- function(x, engine = x$engine, ...) {
 
 #' @export
 check_args.surv_reg <- function(object, call = rlang::caller_env()) {
-
   if (object$engine == "flexsurv") {
-
     args <- lapply(object$args, rlang::eval_tidy)
 
     # `dist` has no default in the function
-    if (all(names(args) != "dist") || is.null(args$dist))
+    if (all(names(args) != "dist") || is.null(args$dist)) {
       object$args$dist <- "weibull"
+    }
   }
 
   invisible(object)
@@ -132,6 +136,11 @@ flexsurv_mean <- function(results, object) {
 flexsurv_quant <- function(results, object) {
   results <- map(results, as_tibble)
   names(results) <- NULL
-  results <- map(results, setNames, c(".quantile", ".pred", ".pred_lower", ".pred_upper"))
+  results <- map(
+    results,
+    setNames,
+    c(".quantile", ".pred", ".pred_lower", ".pred_upper")
+  )
 }
 
+# nocov end

R/surv_reg_data.R

@@ -1,3 +1,4 @@
+# nocov
 
 set_new_model("surv_reg")
 set_model_mode("surv_reg", "regression")
@@ -50,12 +51,11 @@ set_pred(
     pre = NULL,
     post = flexsurv_mean,
     func = c(fun = "summary"),
-    args =
-      list(
-        object = expr(object$fit),
-        newdata = expr(new_data),
-        type = "mean"
-      )
+    args = list(
+      object = expr(object$fit),
+      newdata = expr(new_data),
+      type = "mean"
+    )
   )
 )
 
@@ -106,11 +106,12 @@ set_pred(
     pre = NULL,
     post = NULL,
     func = c(fun = "predict"),
-    args =
-      list(
-        object = expr(object$fit),
-        newdata = expr(new_data),
-        type = "response"
-      )
+    args = list(
+      object = expr(object$fit),
+      newdata = expr(new_data),
+      type = "response"
+    )
   )
 )
+
+# nocov end