Merge pull request #454 from tidymodels/soft-deprecate-surv_reg

Soft-deprecate `surv_reg()`

Author: hfrick

NEWS.md

@@ -6,7 +6,7 @@
 
 * A new linear SVM model `svm_linear()` is now available with the `LiblineaR` engine (#424) and the `kernlab` engine (#438), and the `LiblineaR` engine is available for `logistic_reg()` as well (#429). These models can use sparse matrices via `fit_xy()` (#447).
 
-* New model specification `survival_reg()` for the new mode `"censored regression"`. (#444)
+* New model specification `survival_reg()` for the new mode `"censored regression"` (#444). `surv_reg()` is now soft-deprecated (#448).
 
 * New model specification `proportional_hazards()` for the `"censored regression"` mode (#451).
 

R/surv_reg.R

@@ -1,5 +1,11 @@
 #' General Interface for Parametric Survival Models
 #'
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' This function is soft-deprecated in favor of `survival_reg()` which uses the
+#' `"censored regression"` mode.
+#'
 #' `surv_reg()` is a way to generate a _specification_ of a model
 #'  before fitting and allows the model to be created using
 #'  R. The main argument for the
@@ -51,9 +57,19 @@
 #' # Parameters can be represented by a placeholder:
 #' surv_reg(dist = varying())
 #'
+#' # ->
+#' show_engines("survival_reg")
+#'
+#' survival_reg()
+#' # Parameters can be represented by a placeholder:
+#' survival_reg(dist = varying())
+#'
+#' @keywords internal
 #' @export
 surv_reg <- function(mode = "regression", dist = NULL) {
 
+  lifecycle::deprecate_soft("0.1.6", "surv_reg()", "survival_reg()")
+
     args <- list(
       dist = enquo(dist)
     )