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 #2546 Updating ABLFL to Null if not "Y" in derive_var_base()example #2560

Merged
merged 16 commits into from
Dec 12, 2024

Conversation

sadchla-codes
Copy link
Collaborator

@sadchla-codes sadchla-codes commented Nov 11, 2024

… 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.

  • 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!

Copy link

github-actions bot commented Nov 11, 2024

Code Coverage

Package Line Rate Health
admiral 98%
Summary 98% (5143 / 5256)

@bms63
Copy link
Collaborator

bms63 commented Nov 18, 2024

Hi @sadchla-codes is this ready for review?

@sadchla-codes sadchla-codes requested a review from bms63 November 19, 2024 20:43
@sadchla-codes
Copy link
Collaborator Author

Hi @sadchla-codes is this ready for review?

Yes! @bms63

Copy link
Collaborator

@bms63 bms63 left a comment

Choose a reason for hiding this comment

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

Can you check to see if other examples have ABLFL = N please

@sadchla-codes
Copy link
Collaborator Author

Can you check to see if other examples have ABLFL = N please

Question @bms63: Would you prefer ABLFL ="N" be replace with blank ("") or NA_character_?

@bms63
Copy link
Collaborator

bms63 commented Nov 20, 2024

I’d prefer it to be standard across examples - but might need to be a case by case basis

@bundfussr
Copy link
Collaborator

Can you check to see if other examples have ABLFL = N please

Question @bms63: Would you prefer ABLFL ="N" be replace with blank ("") or NA_character_?

I think our convention is to use NA_character_.

Copy link
Collaborator

@bms63 bms63 left a comment

Choose a reason for hiding this comment

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

oooohhhhh - standardizing!! @cpiraux look what you have wrought :)

@bms63
Copy link
Collaborator

bms63 commented Nov 22, 2024

@sadchla-codes can you fix this style issue and then we can get this merged in

Copy link
Collaborator

@bms63 bms63 left a comment

Choose a reason for hiding this comment

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

I think this update warrants an entry in the news now!

For character values can you manually left aligned and numeric values right aligned where possible? This will increase readability for the examples and tests when others are reviewing.

I believe you can make this manual update and styler won't complain. Is that correct @bundfussr ?

@bundfussr
Copy link
Collaborator

I believe you can make this manual update and styler won't complain. Is that correct @bundfussr ?

Yes

@bms63
Copy link
Collaborator

bms63 commented Dec 2, 2024

@sadchla-codes can you please align the test data so easier for folks to read the data sets in the examples and test data? tyty

@bms63
Copy link
Collaborator

bms63 commented Dec 12, 2024

Here is that weird one with styler @bundfussr

Manual setting:
image

Running styler resets it - the one above is unchanged but was manually set.
image

If you don't see anything - I say we just move on and get this merged in!

@bundfussr
Copy link
Collaborator

Here is that weird one with styler @bundfussr

Manual setting: image

Running styler resets it - the one above is unchanged but was manually set. image

If you don't see anything - I say we just move on and get this merged in!

The alignment must include the header. For expected_output ~BASETYPE is not aligned to the contents of the column.

@bms63
Copy link
Collaborator

bms63 commented Dec 12, 2024

got it - what an art 🥇

image

@bms63
Copy link
Collaborator

bms63 commented Dec 12, 2024

@bundfussr can i get your blessing/sanity check on this one when you have a moment.

Copy link
Collaborator

@bundfussr bundfussr left a comment

Choose a reason for hiding this comment

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

The examples in derive_var_chg() and derive_var_pchg() should be updated.

R/derive_var_base.R Outdated Show resolved Hide resolved
vignettes/generic.Rmd Outdated Show resolved Hide resolved
@bms63
Copy link
Collaborator

bms63 commented Dec 12, 2024

The examples in derive_var_chg() and derive_var_pchg() should be updated.

updated

@bms63 bms63 merged commit f295044 into main Dec 12, 2024
19 checks passed
@bms63 bms63 deleted the 2546_update_ABLFL_example_derive_var_base branch December 12, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants