feat: #264 deprecate assert_function

pharmaverse · Jun 20, 2023 · 2aeec90 · 2aeec90
1 parent e454000
commit 2aeec90
Show file tree

Hide file tree

Showing 29 changed files with 25 additions and 57 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -6,12 +6,12 @@
 
 ## Breaking Changes
 
-- The following functions have been deprecated from previous admiral versions using the next phase of the deprecation process: (#288)
+- The following functions/arguments have been deprecated from previous admiral versions using the next phase of the deprecation process: (#288)
   - `assert_order_vars()`
   - `quo_c()`
   - `quo_not_missing()`
   - `replace_symbol_in_quo()`
-- The `quosures` argument was replaced by the `expressions` argument in `replace_values_by_names()`, `get_source_vars()`, and `vars2chr()`. (#288)
+  - The `quosures` argument was replaced by the `expressions` argument in `replace_values_by_names()`, `get_source_vars()`, and `vars2chr()`. (#288)
 
 ## Documentation
 

diff --git a/R/assertions.R b/R/assertions.R
@@ -945,6 +945,11 @@ assert_has_variables <- function(dataset, required_vars) {
 #' Checks if the argument is a function and if all expected arguments are
 #' provided by the function.
 #'
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' This function is *deprecated*, please use `assert_function_param()` instead.
+#'
 #' @param arg A function argument to be checked
 #'
 #' @param params A character vector of expected argument names
@@ -963,8 +968,8 @@ assert_has_variables <- function(dataset, required_vars) {
 #'
 #' @export
 #'
-#' @keywords assertion
-#' @family assertion
+#' @keywords deprecated
+#' @family deprecated
 #' @examples
 #' example_fun <- function(fun) {
 #'   assert_function(fun, params = c("x"))
@@ -976,6 +981,9 @@ assert_has_variables <- function(dataset, required_vars) {
 #'
 #' try(example_fun(sum))
 assert_function <- function(arg, params = NULL, optional = FALSE) {
+
+  deprecate_warn("0.6.0", "assert_function()", "assert_function_param()")
+
   assert_character_vector(params, optional = TRUE)
   assert_logical_scalar(optional)
 

diff --git a/man/assert_atomic_vector.Rd b/man/assert_atomic_vector.Rd
diff --git a/man/assert_character_scalar.Rd b/man/assert_character_scalar.Rd
diff --git a/man/assert_character_vector.Rd b/man/assert_character_vector.Rd
diff --git a/man/assert_data_frame.Rd b/man/assert_data_frame.Rd
diff --git a/man/assert_date_vector.Rd b/man/assert_date_vector.Rd
diff --git a/man/assert_expr.Rd b/man/assert_expr.Rd
diff --git a/man/assert_expr_list.Rd b/man/assert_expr_list.Rd
diff --git a/man/assert_filter_cond.Rd b/man/assert_filter_cond.Rd
diff --git a/man/assert_function.Rd b/man/assert_function.Rd
diff --git a/man/assert_function_param.Rd b/man/assert_function_param.Rd
diff --git a/man/assert_has_variables.Rd b/man/assert_has_variables.Rd
diff --git a/man/assert_integer_scalar.Rd b/man/assert_integer_scalar.Rd
diff --git a/man/assert_list_element.Rd b/man/assert_list_element.Rd
diff --git a/man/assert_list_of.Rd b/man/assert_list_of.Rd
diff --git a/man/assert_logical_scalar.Rd b/man/assert_logical_scalar.Rd
diff --git a/man/assert_named.Rd b/man/assert_named.Rd
diff --git a/man/assert_named_exprs.Rd b/man/assert_named_exprs.Rd
diff --git a/man/assert_numeric_vector.Rd b/man/assert_numeric_vector.Rd
diff --git a/man/assert_one_to_one.Rd b/man/assert_one_to_one.Rd
diff --git a/man/assert_order_vars.Rd b/man/assert_order_vars.Rd
diff --git a/man/assert_param_does_not_exist.Rd b/man/assert_param_does_not_exist.Rd
diff --git a/man/assert_s3_class.Rd b/man/assert_s3_class.Rd
diff --git a/man/assert_same_type.Rd b/man/assert_same_type.Rd
diff --git a/man/assert_symbol.Rd b/man/assert_symbol.Rd
diff --git a/man/assert_unit.Rd b/man/assert_unit.Rd
diff --git a/man/assert_vars.Rd b/man/assert_vars.Rd
diff --git a/man/assert_varval_list.Rd b/man/assert_varval_list.Rd