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 #2184 check _keys renaming scheme #2200

Merged
merged 9 commits into from
Nov 7, 2023
Merged

Conversation

zdz2101
Copy link
Collaborator

@zdz2101 zdz2101 commented Oct 27, 2023

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 devel 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?
  • 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)
  • 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!

@zdz2101
Copy link
Collaborator Author

zdz2101 commented Oct 27, 2023

@pharmaverse/admiral I realized that in our codebase check_vars/check_keys is only used in conslidate_metadata() and otherwise the usage of check_type is very consistent, so I just swapped out the appropriate one that follows what check_type generally does which was check_keys

@github-actions
Copy link

github-actions bot commented Oct 27, 2023

Code Coverage

Package Line Rate Health
admiral 98%
Summary 98% (4563 / 4637)

@bms63
Copy link
Collaborator

bms63 commented Nov 3, 2023

@zdz2101 is this still in draft mode or ready to review?

@zdz2101 zdz2101 marked this pull request as ready for review November 3, 2023 17:04
@zdz2101
Copy link
Collaborator Author

zdz2101 commented Nov 3, 2023

@zdz2101 is this still in draft mode or ready to review?

My apologies, yes I suppose it is ready for review, assuming my comment above holds

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.

Don't we add tests for deprecated arguments?

@zdz2101
Copy link
Collaborator Author

zdz2101 commented Nov 6, 2023

Don't we add tests for deprecated arguments?

@bms63 an appropriate test has been added

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.

This looks nice to me!!

@zdz2101 zdz2101 merged commit 708d232 into main Nov 7, 2023
15 of 16 checks passed
@zdz2101 zdz2101 deleted the 2184_check_keys_renaming branch November 7, 2023 15:17
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.

Feature Request: check_keys and check_vars arguments should be renamed to check_unique
2 participants