Closes #2138 Implement derive_vars_extreme_event()

[jeffreyad]

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 devel branch until you have checked off each task.

• Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
• Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
• Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide
• If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
• Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
• Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
• Address any updates needed for vignettes and/or templates
• Update NEWS.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)
• Build admiral site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.
• Address or fix all lintr warnings and errors - lintr::lint_package()
• Run R CMD check locally and address all errors and warnings - devtools::check()
• Link the issue in the Development Section on the right hand side.
• Address all merge conflicts and resolve appropriately
• Pat yourself on the back for a job well done! Much love to your accomplishment!

[github-actions]

Package	Line Rate	Health
admiral	98%	✔
Summary	98% (4680 / 4776)	✔

[jeffreyad]

@bundfussr I'm not sure if this is exactly what you had in mind, but it seemed like the best option was to create a new helper function derive_extreme() which does most of what derive_extreme_event() previously did and then call that function in two new wrapper functions derive_extreme_event() and derive_vars_extreme_event() to either add the new records as new observations or new variables.

[bundfussr]

@bundfussr I'm not sure if this is exactly what you had in mind, but it seemed like the best option was to create a new helper function derive_extreme() which does most of what derive_extreme_event() previously did and then call that function in two new wrapper functions derive_extreme_event() and derive_vars_extreme_event() to either add the new records as new observations or new variables.

Sounds good to me. I'll have a closer look later today or on Monday.

[bms63]

Do we want users to have access to this help function? I'm thinking no???

[bms63]

I think if you add pharmaversesdtm to the Remotes you can get the new changes there so the R-CMD checks pass again? @ddsjoberg correct?

You might need to change the Imports to the specific version - new territory for me as well!!

[ddsjoberg]

@bms63 which R CMD Check error are you trying to solve with the Remotes:?

[bundfussr]

• Please update the ADSL vignette and template.
• Please supersede dthcaus_source and date_source.

[bms63]

@bms63 which R CMD Check error are you trying to solve with the Remotes:?

My understanding is this is related to a recent update in pharmaversesdtm

[bundfussr]

@bms63 which R CMD Check error are you trying to solve with the Remotes:?

My understanding is this is related to a recent update in pharmaversesdtm

Unfortunately, the development version is broken at the moment. We need to merge pharmaverse/pharmaversesdtm#78 and #2241 to fix it.

[manciniedoardo]

Hi all - hope you don't mind me removing myself from review of this as I won't have time to do a thorough review - please feel free to ask someone else if required.

[bms63]

Could we still split this function out into a new file out so it is easy to find in the R folder. I think the events stuff should also get put into a new file, but understand if that is overkill and others don't want to split out

[jeffreyad]

@bms63 Ok, I split into three files.

[jeffreyad]

• Please update the ADSL vignette and template.
• Please supersede dthcaus_source and date_source.

Superseded dthcaus_source and date_source.

[bundfussr]

Almost done. Just one comment left.

[bundfussr]

Thanks for your patience.

[jeffreyad]

Thanks for your patience.

Thanks! I thought of one more thing: I could remove set_values_to from derive_vars_extreme_event() since we set it to NULL in derive_extreme_event().

[bms63]

I'm happy! @jeffreyad @bundfussr shall we click the button!!??!!