Closes #2141 Superseded derive_param_extreme_record() (#2174)

* superseded fun * Update NEWS.md * added badge * doc update * feat: #2141 supersede section * chore: #2141 docs --------- Co-authored-by: Zelos Zhu <[email protected]> Co-authored-by: Ben Straub <[email protected]>
pharmaverse · Oct 25, 2023 · dd8f8d9 · dd8f8d9
1 parent 1ebc258
commit dd8f8d9
Show file tree

Hide file tree

Showing 21 changed files with 21 additions and 52 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -48,12 +48,17 @@ were enhanced such that more than one summary variable can be derived, e.g.,
   - `derive_expected_records(dataset_expected_obs)` 
   - `derive_var_ontrtfl(span_period)` 
 
+- The `derive_param_extreme_record()` function has been superseded in favor of `derive_extreme_event()`. (#2141)
+
 ## Documentation
 
 - A way to standardize roxygen labels and descriptions for function arguments was implemented and tested (#2034)
 
 - Link to published CDISC Population PK (ADPPK) implementation guide added. (#2161)
 
+- Removed Deprecation section in Reference tab.  Added new Superseded section in 
+Reference tab. (#2174)
+
 ## Various
 
 - Website now has button/links to Slack channel and GitHub Issues (#2127)

diff --git a/R/derive_param_extreme_record.R b/R/derive_param_extreme_record.R
@@ -1,5 +1,9 @@
 #' Adds a Parameter Based on First or Last Record from Multiple Sources
 #'
+#' @description
+#' `r lifecycle::badge("superseded")` The `derive_param_extreme_record()`
+#' function has been superseded in favor of `derive_extreme_event()`.
+#'
 #' Generates parameter based on the first or last observation from multiple
 #' source datasets, based on user-defined filter, order and by group criteria.
 #' All variables of the selected observation are kept.
@@ -71,8 +75,8 @@
 #' The input dataset with the first or last observation of each by group
 #' added as new observations.
 #'
-#' @family der_prm_bds_findings
-#' @keywords der_prm_bds_findings
+#' @family superseded
+#' @keywords superseded
 #'
 #' @export
 #' @examples

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -128,19 +128,13 @@ reference:
   contents:
   - has_keyword('reexport')
 
-- title: Deprecated
+- title: Superseded
   desc: |
-    As `{admiral}` is still evolving, functions/parameters may need to be removed or replaced over time. In such cases, the function/parameter will enter the following 6-month deprecation cycle:
-
-    * In the first release (0-3 months), there will be a warning issued if you use the function/parameter, but it will still be available to use.
-    * In the following release (3-6 months), an error will be produced if you use the function/parameter.
-    * Finally, from the 3rd release (6 months) onwards, the function/parameter will be removed from `{admiral}` and its documentation completely.
-
-    *Note: Guidance on replacement functionality can be found in the warning/error message produced or in the function's documentation.*
-
-    Below, you can find a list of functions in the process of being deprecated:
+    Superseded functions have been replaced with better functions. However, we
+    will not be removing these functions from `{admiral}`.  We do strongly
+    encourage you to make the switch over.
   contents:
-  - has_keyword("deprecated")
+  - has_keyword("superseded")
 
 navbar:
   structure:

diff --git a/man/default_qtc_paramcd.Rd b/man/default_qtc_paramcd.Rd
diff --git a/man/derive_expected_records.Rd b/man/derive_expected_records.Rd
diff --git a/man/derive_extreme_event.Rd b/man/derive_extreme_event.Rd
diff --git a/man/derive_extreme_records.Rd b/man/derive_extreme_records.Rd
diff --git a/man/derive_locf_records.Rd b/man/derive_locf_records.Rd
diff --git a/man/derive_param_bmi.Rd b/man/derive_param_bmi.Rd
diff --git a/man/derive_param_bsa.Rd b/man/derive_param_bsa.Rd
diff --git a/man/derive_param_computed.Rd b/man/derive_param_computed.Rd
diff --git a/man/derive_param_doseint.Rd b/man/derive_param_doseint.Rd
diff --git a/man/derive_param_exist_flag.Rd b/man/derive_param_exist_flag.Rd
diff --git a/man/derive_param_exposure.Rd b/man/derive_param_exposure.Rd
diff --git a/man/derive_param_extreme_record.Rd b/man/derive_param_extreme_record.Rd
diff --git a/man/derive_param_framingham.Rd b/man/derive_param_framingham.Rd
diff --git a/man/derive_param_map.Rd b/man/derive_param_map.Rd
diff --git a/man/derive_param_qtc.Rd b/man/derive_param_qtc.Rd
diff --git a/man/derive_param_rr.Rd b/man/derive_param_rr.Rd
diff --git a/man/derive_param_wbc_abs.Rd b/man/derive_param_wbc_abs.Rd
diff --git a/man/derive_summary_records.Rd b/man/derive_summary_records.Rd