Skip to content

Conversation

@rossfarrugia
Copy link
Collaborator

@rossfarrugia rossfarrugia commented May 21, 2025

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!

@rossfarrugia rossfarrugia linked an issue May 21, 2025 that may be closed by this pull request
@github-actions
Copy link

Code Coverage

Package Line Rate Health
admiral 98%
Summary 98% (5325 / 5430)

@rossfarrugia rossfarrugia requested a review from bundfussr May 21, 2025 10:50
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.

@rossfarrugia should we make an issue to update this in pharmaverse examples and update the spec. this is a nice one

@rossfarrugia
Copy link
Collaborator Author

@rossfarrugia should we make an issue to update this in pharmaverse examples and update the spec. this is a nice one

@bms63 i'm happy to go with your call here. We don't use this one much at Roche to my knowledge but if you think useful to add to the example then can't harm

@bms63
Copy link
Collaborator

bms63 commented May 22, 2025

yeah i'll just a make issue that it could be added if someone was interested in doing it.

@bms63 bms63 merged commit 2fe1b64 into main May 22, 2025
19 checks passed
@bms63 bms63 deleted the 2737_occds_add_doseon branch May 22, 2025 15:35
@bms63
Copy link
Collaborator

bms63 commented May 22, 2025

pharmaverse/examples#103

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: Add DOSEON variable to OCCDS vignette

3 participants