Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closes #2141 Superseded derive_param_extreme_record() #2174

Merged
merged 8 commits into from
Oct 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 6 additions & 2 deletions R/derive_param_extreme_record.R
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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
Expand Down
16 changes: 5 additions & 11 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 0 additions & 1 deletion man/default_qtc_paramcd.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_expected_records.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_extreme_event.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_extreme_records.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_locf_records.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_param_bmi.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_param_bsa.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_param_computed.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_param_doseint.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_param_exist_flag.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_param_exposure.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

27 changes: 5 additions & 22 deletions man/derive_param_extreme_record.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_param_framingham.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_param_map.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_param_qtc.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_param_rr.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_param_wbc_abs.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/derive_summary_records.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading