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 #2338: keep_nas = TRUE example in derive_param_computed() documentation #2428

Merged
merged 4 commits into from
May 13, 2024

Conversation

manciniedoardo
Copy link
Collaborator

Closes #2338

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 version of it to the same folder.
  • 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!

@manciniedoardo
Copy link
Collaborator Author

@bms63 @bundfussr I added the example by adding ADT and ADTF variables to the advs object. I did it on a new line to avoid overflowing past 100 chars in the tibble, not sure if this is the best approach though as it's not super neat?

@w316liu please feel free to take a look as well!

Copy link

github-actions bot commented May 9, 2024

Code Coverage

Package Line Rate Health
admiral 97%
Summary 97% (4685 / 4813)

Comment on lines 194 to 196
Example 1b: Using option `keep_nas = TRUE` to derive MAP in the case where some/all values
of a variable used in the computation are missing

Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there data that has NAs in it? I don't see it here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

ADTF is all NA and it's one of the variables inside set_values_to in the second example (1b)

Copy link
Collaborator

Choose a reason for hiding this comment

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

oh right - okay I thought it was the specific calculation for doing MAP that needed NAs, but looking at issue I see I was misunderstanding.

I think you need to add a # in your comment for 1b for the checks to pass.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

ah yes of course, thanks

@bms63
Copy link
Collaborator

bms63 commented May 10, 2024

The error is still persisting :(

@manciniedoardo
Copy link
Collaborator Author

The error is still persisting :(

fixed now

@bms63 bms63 merged commit c7f77a9 into main May 13, 2024
16 checks passed
@bms63 bms63 deleted the 2338_add_keep_nas_example_in_derive_param_computed branch May 13, 2024 12:03
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.

Documentation: unable to derive a new variable using derive_param_computed() when source variable is NA
2 participants