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 #2581 - enhance test coverage: derive_var_trtemfl.R #2608

Merged
merged 8 commits into from
Dec 20, 2024

Conversation

jimrothstein
Copy link
Collaborator

@jimrothstein jimrothstein commented Dec 12, 2024

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.

  • 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?
  • Review the Cheat Sheet. Make any required updates to it by editing the file inst/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.)
  • 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). A Developer Notes section is available in NEWS.md for tracking developer-facing issues.
  • 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!

@jimrothstein jimrothstein marked this pull request as draft December 12, 2024 23:13
Copy link

github-actions bot commented Dec 12, 2024

Code Coverage

Package Line Rate Health
admiral 98%
Summary 98% (5188 / 5297)

@jimrothstein jimrothstein self-assigned this Dec 12, 2024
@jimrothstein jimrothstein marked this pull request as ready for review December 12, 2024 23:49
@bundfussr bundfussr linked an issue Dec 13, 2024 that may be closed by this pull request
1 task
@bundfussr bundfussr changed the title Closes 2581 - enhance test coverage: derive_var_trtemfl.R Closes #2581 - enhance test coverage: derive_var_trtemfl.R Dec 13, 2024
Comment on lines 210 to 216
expect_error(
derive_var_trtemfl(
adae,
group_var = AEGRPID,
subject_keys = NULL
)
)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use expect_snapshot() to ensure that the correct error message is issued.

By the way, unit test for errors and warnings should never accept any error or warning but always check that the expected one is issued (by using expect_snapshot() or the class argument of expect_error()/expect_warning() ).

@bms63 , maybe we should add this to the unit test guidance. What do you think?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes good idea we should update!! - i think i cleared an update for tests in derive_vars_transposed() that didn't meet our practices. @jimrothstein no problems with the last PR that was on me I should of remembered this!!

but now we can document it...maybe it should even go in the PR template? Hard to remember all these details!!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think i cleared an update for tests in derive_vars_transposed() that didn't meet our practices.

I've fixed it in #2592.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is your daily caffeine, food intake, and general regimen!!?? how are you so productive!! thanks!!!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @bundfussr.

Made note to myself and will look over your other suggestions.

Please use expect_snapshot() to ensure that the correct error message is issued.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is your daily caffeine, food intake, and general regimen!!?? how are you so productive!! thanks!!!

no coffee, just tea 🍵

@bms63
Copy link
Collaborator

bms63 commented Dec 14, 2024

Feels strange that there are 20 files being changed here. They look like all recent updates, but wondering why github is detecting them as new changes???

@jimrothstein
Copy link
Collaborator Author

Good eyes; I think this is what happened:

  • locally, accidently commited to main (bad)
  • couldn't undo (git commit --hard) ; went downhill.
  • evenutally, I was able to get main back but at an EARLIER commit ? (c03891152)
  • SEE ATTACHED (very bottom)
    Screenshot from 2024-12-14 14-38-10

@bms63
Copy link
Collaborator

bms63 commented Dec 15, 2024

So...for this type of git issue I think the easiest course of action is to just create a new branch off main and copy the one update to the new branch.

I wouldn't fuss with all this git-fu needed to fix this issue. If it was a huge rework of 20+ files, then yes we should do it this way, but I like simple!! As I am a simple man :)

@bundfussr bundfussr merged commit 982faf8 into main Dec 20, 2024
18 of 19 checks passed
@bundfussr bundfussr deleted the 2581_enhance_test_coverage_derive_var_trtemfl branch December 20, 2024 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhance test coverage for derive_var_trtemfl()
3 participants