-
Notifications
You must be signed in to change notification settings - Fork 64
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 #2521 remove lifecycle deprecation code for get summary records #2568
base: main
Are you sure you want to change the base?
Closes #2521 remove lifecycle deprecation code for get summary records #2568
Conversation
Do I have this right?? Once removed, nothing stops user from using deprecated formal argument (such as `analysis_var`) SEE test-get_summary_records.R test #4
#2521 - First attempt: Removing lifecycle deprecation code for Could you clarify, please? |
Please remove argument from function and related code. also good to check tests for the argument to see if those need to be excised. I don’t think this function gets called by user but always good to check vignettes and templates oh and the documentation - should be cleaned up as well thanks!! |
…et_summary_records
…tempts to call with deprecated arguments `analysis_var` or `summary_fun`
Not yet done: vignettes/templates for deprecated formal arguments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jimrothstein This new test you have included is not needed.
We have been letting users know for about a year that these arguments are being removed from this admiral function. We have a pretty generous timeline for deprecating stuff. Once we conclude the deprecation timeline we remove everything from the function, any tests, documentation, etc and we no longer need to do anything to support it.
Unless I am missing something?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And many thanks for jumping in here!! we try to follow tidyverse deprecation guidelines, but we are more conservative. New deprecation timelines are coming that are multi-year!! eeckkk!!
…et_summary_records
`derive_param_exposure.R` documentation mentions now deprecated (and gone) variables `analysis_var` `summary_fun`
Removed unneeded test... understood! derive_param_exposure.R
locally, test admiral throwing errors
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add an item to NEWS.md
Good catch! It seems that we missed it before. |
NEWS.md
Outdated
@@ -37,6 +37,8 @@ example, `">2.5 x ULN"` changed to `">2.5"` for grade 3. (#2534) | |||
|
|||
- test scripts, R, and markdown files for `create_single_dose_dataset` and `occds.Rmd` updated to include a `STUDYID` column because of `get_admiral_option("subject_keys")` update above. (#2501) | |||
|
|||
- In `get_summary_records()`, previously deprecated formal arguments `analysis_var` and `summary_fun` now removed from function, documentation, tests etc. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- In `get_summary_records()`, previously deprecated formal arguments `analysis_var` and `summary_fun` now removed from function, documentation, tests etc. | |
- In `get_summary_records()`, previously deprecated formal arguments `analysis_var` and `summary_fun` now removed from function, documentation, tests etc. (#2521) |
Something I did ? (I use linux) |
…et_summary_records
Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral codebase remains robust and consistent.
Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the
main
branch until you have checked off each task.styler::style_file()
to style R and Rmd filesinst/cheatsheet/admiral_cheatsheet.pptx
and re-upload a PDF and a PNG version of it to the same folder. (The PNG version can be created by taking a screenshot of the PDF version.)devtools::document()
so all.Rd
files in theman
folder and theNAMESPACE
file in the project root are updated appropriatelyNEWS.md
under the header# admiral (development version)
if the changes pertain to a user-facing function (i.e. it has an@export
tag) or documentation aimed at users (rather than developers). A Developer Notes section is available inNEWS.md
for tracking developer-facing issues.pkgdown::build_site()
and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.lintr::lint_package()
R CMD check
locally and address all errors and warnings -devtools::check()