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 #2517 Attempt to clarify datasets in template: ad_adsl.R #2531

Merged
merged 9 commits into from
Oct 25, 2024

Conversation

jimrothstein
Copy link
Collaborator

@jimrothstein jimrothstein commented Oct 10, 2024

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
Copy link
Collaborator Author

jimrothstein commented Oct 10, 2024

@bundfussr @bms63

"Spruce" - This is minimal change to comments; open to more suggestions.
Once this template (ad_adsl.R) is done; will follow same pattern for other templates.

  • Remove superceded functions: Would lifecycle::deprecate_warn() serve any purpose?
    Or just remove. period.

@bms63
Copy link
Collaborator

bms63 commented Oct 10, 2024

Hi @jimrothstein can you just "spruce up" to what was requested in the issue. #2517

If you want to change the language in the templates can you please make an agenda item for next week's discussion. I'll put an agenda together tomorrow and you can add it there. If core team agrees to updating the language then we should do it for all templates.

@jimrothstein
Copy link
Collaborator Author

@bms63
Sorry Ben, now I see the change ; a dataset was added.

NEWS.md Outdated Show resolved Hide resolved
inst/templates/ad_adsl.R Outdated Show resolved Hide resolved
inst/templates/ad_adsl.R Outdated Show resolved Hide resolved
@jimrothstein jimrothstein self-assigned this Oct 11, 2024
Co-authored-by: Stefan Bundfuss <80953585+bundfussr@users.noreply.github.com>
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.

Thanks Jim! I just updated news requested by @bundfussr. Feel free to make discussion around issues in slack admiraldev channel or here on github for things that you think need fixing! :)

bms63 and others added 2 commits October 25, 2024 16:46
Co-authored-by: Stefan Bundfuss <80953585+bundfussr@users.noreply.github.com>
@bms63 bms63 merged commit add4b1d into pharmaverse:main Oct 25, 2024
17 of 18 checks passed
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.

3 participants