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 # 2580 increase coverage derive_vars_merged #2619

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jimrothstein
Copy link
Collaborator

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 changed the title Closes # 2580 update this branch to latest (from main) Closes # 2580 increase coverage derive_vars_merged Dec 21, 2024
Copy link

Code Coverage

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

@jimrothstein
Copy link
Collaborator Author

jimrothstein commented Dec 21, 2024

This is DRAFT, not PR

Claim: function get_not_mapped() will NEVER run ... and can not be tested

This is bit tedious, but working backwards here is my logic ...
(Is there a better tool?)

GOAL: test this function get_not_mapped

get_not_mapped <- function() {

To do so, this call must run:

i = "Run {.run admiral::get_not_mapped()} to access the full list."

But this can happen only if df temp_not_mapped is not empty.

if (nrow(temp_not_mapped) > 0) {

But temp_not_mapped not empty only if tmp_lookup_flag IS NA (filter(FALSE) returns no rows)

admiral/R/derive_merged.R

Lines 745 to 746 in 97dd096

temp_not_mapped <- res %>%
filter(is.na(!!tmp_lookup_flag)) %>%

But flag tmp_lookup_flag IS NOT NA

tmp_lookup_flag <- get_new_tmp_var(dataset_add, prefix = "tmp_lookup_flag")

@jimrothstein jimrothstein requested a review from bms63 December 21, 2024 21:11
@bms63
Copy link
Collaborator

bms63 commented Dec 22, 2024

This is DRAFT, not PR

Claim: function get_not_mapped() will NEVER run ... and can not be tested

This is bit tedious, but working backwards here is my logic ... (Is there a better tool?)

GOAL: test this function get_not_mapped

get_not_mapped <- function() {

To do so, this call must run:

i = "Run {.run admiral::get_not_mapped()} to access the full list."

But this can happen only if df temp_not_mapped is not empty.

if (nrow(temp_not_mapped) > 0) {

But temp_not_mapped not empty only if tmp_lookup_flag IS NA (filter(FALSE) returns no rows)

admiral/R/derive_merged.R

Lines 745 to 746 in 97dd096

temp_not_mapped <- res %>%
filter(is.na(!!tmp_lookup_flag)) %>%

But flag tmp_lookup_flag IS NOT NA

tmp_lookup_flag <- get_new_tmp_var(dataset_add, prefix = "tmp_lookup_flag")

@bundfussr would have better insights on this function as he wrote 98% of it I believe :)

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.

2 participants