diff --git a/NEWS.md b/NEWS.md index 712816b14a..f4732e6a7c 100644 --- 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 index e55431b7ea..cf31b829c3 100644 --- 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 index 9d25486b16..4e0842e54e 100644 --- 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 index ae579dc2e3..8cedfe072a 100644 --- a/man/default_qtc_paramcd.Rd +++ b/man/default_qtc_paramcd.Rd @@ -35,7 +35,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()}, diff --git a/man/derive_expected_records.Rd b/man/derive_expected_records.Rd index 43bbe10b66..b66673c9dd 100644 --- a/man/derive_expected_records.Rd +++ b/man/derive_expected_records.Rd @@ -109,7 +109,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()}, diff --git a/man/derive_extreme_event.Rd b/man/derive_extreme_event.Rd index e61c514891..c21de5a24c 100644 --- a/man/derive_extreme_event.Rd +++ b/man/derive_extreme_event.Rd @@ -385,7 +385,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()}, diff --git a/man/derive_extreme_records.Rd b/man/derive_extreme_records.Rd index a394c9b104..48b88a38ac 100644 --- a/man/derive_extreme_records.Rd +++ b/man/derive_extreme_records.Rd @@ -302,7 +302,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()}, diff --git a/man/derive_locf_records.Rd b/man/derive_locf_records.Rd index dc8cb92d95..8d606fdad4 100644 --- a/man/derive_locf_records.Rd +++ b/man/derive_locf_records.Rd @@ -135,7 +135,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()}, diff --git a/man/derive_param_bmi.Rd b/man/derive_param_bmi.Rd index ecca7410dc..1696b634d0 100644 --- a/man/derive_param_bmi.Rd +++ b/man/derive_param_bmi.Rd @@ -178,7 +178,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()}, diff --git a/man/derive_param_bsa.Rd b/man/derive_param_bsa.Rd index 78a98814e6..d8a3e4d5c6 100644 --- a/man/derive_param_bsa.Rd +++ b/man/derive_param_bsa.Rd @@ -203,7 +203,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()}, diff --git a/man/derive_param_computed.Rd b/man/derive_param_computed.Rd index 88002805cb..145d7fb85c 100644 --- a/man/derive_param_computed.Rd +++ b/man/derive_param_computed.Rd @@ -309,7 +309,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()}, diff --git a/man/derive_param_doseint.Rd b/man/derive_param_doseint.Rd index 877ac7d3ad..842ef9cc8d 100644 --- a/man/derive_param_doseint.Rd +++ b/man/derive_param_doseint.Rd @@ -148,7 +148,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_computed}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()}, diff --git a/man/derive_param_exist_flag.Rd b/man/derive_param_exist_flag.Rd index f56fdbb032..415d4c8c28 100644 --- a/man/derive_param_exist_flag.Rd +++ b/man/derive_param_exist_flag.Rd @@ -183,7 +183,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_computed}()}, \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()}, diff --git a/man/derive_param_exposure.Rd b/man/derive_param_exposure.Rd index c946090150..e54fd5704d 100644 --- a/man/derive_param_exposure.Rd +++ b/man/derive_param_exposure.Rd @@ -160,7 +160,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_computed}()}, \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()}, diff --git a/man/derive_param_extreme_record.Rd b/man/derive_param_extreme_record.Rd index 6660b91d3f..3b68ae01d2 100644 --- a/man/derive_param_extreme_record.Rd +++ b/man/derive_param_extreme_record.Rd @@ -72,6 +72,9 @@ The input dataset with the first or last observation of each by group added as new observations. } \description{ +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#superseded}{\figure{lifecycle-superseded.svg}{options: alt='[Superseded]'}}}{\strong{[Superseded]}} The \code{derive_param_extreme_record()} +function has been superseded in favor of \code{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. @@ -138,25 +141,5 @@ derive_param_extreme_record( ) ) } -\seealso{ -BDS-Findings Functions for adding Parameters/Records: -\code{\link{default_qtc_paramcd}()}, -\code{\link{derive_expected_records}()}, -\code{\link{derive_extreme_event}()}, -\code{\link{derive_extreme_records}()}, -\code{\link{derive_locf_records}()}, -\code{\link{derive_param_bmi}()}, -\code{\link{derive_param_bsa}()}, -\code{\link{derive_param_computed}()}, -\code{\link{derive_param_doseint}()}, -\code{\link{derive_param_exist_flag}()}, -\code{\link{derive_param_exposure}()}, -\code{\link{derive_param_framingham}()}, -\code{\link{derive_param_map}()}, -\code{\link{derive_param_qtc}()}, -\code{\link{derive_param_rr}()}, -\code{\link{derive_param_wbc_abs}()}, -\code{\link{derive_summary_records}()} -} -\concept{der_prm_bds_findings} -\keyword{der_prm_bds_findings} +\concept{superseded} +\keyword{superseded} diff --git a/man/derive_param_framingham.Rd b/man/derive_param_framingham.Rd index 8aec00eec6..c0af0dd586 100644 --- a/man/derive_param_framingham.Rd +++ b/man/derive_param_framingham.Rd @@ -244,7 +244,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()}, \code{\link{derive_param_rr}()}, diff --git a/man/derive_param_map.Rd b/man/derive_param_map.Rd index 472e26bd56..40f437bd82 100644 --- a/man/derive_param_map.Rd +++ b/man/derive_param_map.Rd @@ -154,7 +154,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_qtc}()}, \code{\link{derive_param_rr}()}, diff --git a/man/derive_param_qtc.Rd b/man/derive_param_qtc.Rd index 594b7b1cd3..5840aaf545 100644 --- a/man/derive_param_qtc.Rd +++ b/man/derive_param_qtc.Rd @@ -152,7 +152,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_rr}()}, diff --git a/man/derive_param_rr.Rd b/man/derive_param_rr.Rd index ddf944a837..7ce0684b56 100644 --- a/man/derive_param_rr.Rd +++ b/man/derive_param_rr.Rd @@ -115,7 +115,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()}, diff --git a/man/derive_param_wbc_abs.Rd b/man/derive_param_wbc_abs.Rd index 15c8555dc6..86b506accc 100644 --- a/man/derive_param_wbc_abs.Rd +++ b/man/derive_param_wbc_abs.Rd @@ -126,7 +126,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()}, diff --git a/man/derive_summary_records.Rd b/man/derive_summary_records.Rd index eba2324687..d706207c86 100644 --- a/man/derive_summary_records.Rd +++ b/man/derive_summary_records.Rd @@ -183,7 +183,6 @@ BDS-Findings Functions for adding Parameters/Records: \code{\link{derive_param_doseint}()}, \code{\link{derive_param_exist_flag}()}, \code{\link{derive_param_exposure}()}, -\code{\link{derive_param_extreme_record}()}, \code{\link{derive_param_framingham}()}, \code{\link{derive_param_map}()}, \code{\link{derive_param_qtc}()},