feat: #2142 intiial superseding step

pharmaverse · Oct 6, 2023 · 1b7e9ab · 1b7e9ab
1 parent b800ab1
commit 1b7e9ab
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/R/get_summary_records.R b/R/get_summary_records.R
@@ -1,6 +1,13 @@
 #' Create Summary Records
 #'
 #' @description
+#'
+#' `r lifecycle::badge("superseded")`
+#'
+#' Development on `get_summary_records()` is complete, and for new code we recommend
+#' switching to using the `dataset_add` argument in `derive_summary_records()`,
+#' which is easier to use, more featureful, and still under active development.
+#'
 #' It is not uncommon to have an analysis need whereby one needs to derive an
 #' analysis value (`AVAL`) from multiple records. The ADaM basic dataset
 #' structure variable `DTYPE` is available to indicate when a new derived
@@ -151,6 +158,13 @@ get_summary_records <- function(dataset,
                                 analysis_var,
                                 summary_fun,
                                 set_values_to = NULL) {
+  inform(
+    message = paste0(
+      "`get_summary_records()` has been superseded, ",
+      "please use the `dataset_add` argument in `derive_summary_records()`",
+      sep = ""
+    )
+  )
   assert_vars(by_vars)
   analysis_var <- assert_symbol(enexpr(analysis_var))
   filter <- assert_filter_cond(enexpr(filter), optional = TRUE)

diff --git a/man/get_summary_records.Rd b/man/get_summary_records.Rd