Closes #<2841> documentation derive vars dt clarify highest imputation definitions expand min dates example and add max dates example
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.
- [x] Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
- [x] Code is formatted according to the tidyverse style guide. Run
styler::style_file()to style R and Rmd files - [x] 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
- [x] If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
- [x] Review the Cheat Sheet. Make any required updates to it by editing the file
inst/cheatsheet/admiral_cheatsheet.pptxand 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.) - [x] Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
- [x] Run
devtools::document()so all.Rdfiles in themanfolder and theNAMESPACEfile in the project root are updated appropriately - [x] Address any updates needed for vignettes and/or templates
- [x] Update
NEWS.mdunder the header# admiral (development version)if the changes pertain to a user-facing function (i.e. it has an@exporttag) or documentation aimed at users (rather than developers). A Developer Notes section is available inNEWS.mdfor tracking developer-facing issues. - [x] 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. - [x] Address or fix all lintr warnings and errors -
lintr::lint_package() - [x] Run
R CMD checklocally and address all errors and warnings -devtools::check() - [x] Link the issue in the Development Section on the right hand side.
- [x] Address all merge conflicts and resolve appropriately
- [x] Pat yourself on the back for a job well done! Much love to your accomplishment!
Definition of Done from the issue:
- [x] Functions argument where letters are specified, e.g. "Y" and "n" have the meanings of the letters explained next to them, i.e. If "n" (none, lowest level) is specified...
- [x] The min_dates example has text corrected (see below comment) and is expanded to be more records/scenarios.
- [x] A max_dates example is created that has similar records/scenarios.
| Package | Line Rate | Health |
|---|---|---|
| admiral | 100% | ✔ |
| Summary | 100% (5714 / 5722) | ✔ |
Just for a sanity check - can you review the max and min date arguments in the tests and make sure we have some deeper coverage - the arguemnts are covered but we tend to not go very deep? Maybe even these examples could be just thrown in as the tests?
It seems to me that the existing tests cover the handling of minimum and maximum dates. The new examples do not seem to add much to the tests. If i'm wrong or If you have a specific case in mind to test, please let me know.
Just for a sanity check - can you review the max and min date arguments in the tests and make sure we have some deeper coverage - the arguemnts are covered but we tend to not go very deep? Maybe even these examples could be just thrown in as the tests?
It seems to me that the existing tests cover the handling of minimum and maximum dates. The new examples do not seem to add much to the tests. If i'm wrong or If you have a specific case in mind to test, please let me know.
Thanks for check!! No need to add more tests if looking sufficient.