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 #23: ADVS template program #35

Merged
merged 10 commits into from
Nov 6, 2024
Merged

Closes #23: ADVS template program #35

merged 10 commits into from
Nov 6, 2024

Conversation

AndersAskeland
Copy link
Member

@AndersAskeland AndersAskeland commented Oct 5, 2024

Closes #23
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 family 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?
  • 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<ext> (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 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!

@AndersAskeland AndersAskeland changed the title Closes #23 ADVS template program Closes #23: ADVS template program Oct 5, 2024
@AndersAskeland AndersAskeland self-assigned this Oct 5, 2024
Copy link

github-actions bot commented Oct 5, 2024

Code Coverage

Package Line Rate Health
admiralmetabolic 100%
Summary 100% (3 / 3)

@AndersAskeland AndersAskeland marked this pull request as ready for review October 5, 2024 16:34
@AndersAskeland
Copy link
Member Author

Think it should be ready for review now. Feel free to review @pharmaverse/admiralmetabolic .

I've used a somewhat different layout/setup compared to the other admiral packages. For me it makes more sense, but please let me know if it appears strange.

Copy link
Collaborator

@manciniedoardo manciniedoardo left a comment

Choose a reason for hiding this comment

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

Thanks @AndersAskeland!

I did a quick review and left some initial comments - I haven't tired executing the template yet.

In general, I am wondering if we would benefit from building on the existing ADVS template from {admiral} (rather than starting afresh like here) and just adding our extra bits? It would make review easier as well. interested in your thoughts.

inst/ad_advs.R Outdated Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
Copy link

@starosto starosto left a comment

Choose a reason for hiding this comment

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

Hi @AndersAskeland , I have posted some comments. Well done!

inst/ad_advs.R Outdated Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
@AndersAskeland
Copy link
Member Author

@pharmaverse/admiralmetabolic If anyone have time, please have a review of the template.

inst/templates/ad_advs.R Outdated Show resolved Hide resolved
inst/templates/ad_advs.R Outdated Show resolved Hide resolved
inst/templates/ad_advs.R Outdated Show resolved Hide resolved
inst/templates/ad_advs.R Outdated Show resolved Hide resolved
inst/templates/ad_advs.R Show resolved Hide resolved
inst/templates/ad_advs.R Show resolved Hide resolved
inst/ad_advs.R Outdated Show resolved Hide resolved
Copy link

@starosto starosto left a comment

Choose a reason for hiding this comment

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

@AndersAskeland I added some comments. I also wonder if we should not build on existing ADVS templates from {admiral}. If not now, then for future templates.

inst/templates/ad_advs.R Show resolved Hide resolved
Copy link
Collaborator

@manciniedoardo manciniedoardo left a comment

Choose a reason for hiding this comment

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

LGTM @AndersAskeland 😄 (after comments from @starosto are addressd)

inst/templates/ad_advs.R Outdated Show resolved Hide resolved
inst/templates/ad_advs.R Outdated Show resolved Hide resolved
inst/templates/ad_advs.R Outdated Show resolved Hide resolved
inst/templates/ad_advs.R Outdated Show resolved Hide resolved
inst/templates/ad_advs.R Outdated Show resolved Hide resolved
inst/templates/ad_advs.R Show resolved Hide resolved
inst/templates/ad_advs.R Outdated Show resolved Hide resolved
inst/templates/ad_advs.R Outdated Show resolved Hide resolved
inst/templates/ad_advs.R Outdated Show resolved Hide resolved
@AndersAskeland
Copy link
Member Author

Thanks for all the comments and suggestions. Most are now implemented - if you want, have a quick look. It would be great to have it merged before our meeting tomorrow.

Copy link
Contributor

@yurovska yurovska left a comment

Choose a reason for hiding this comment

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

I don't see a commit changing AVISIT from Screening to Baseline for HEIGHT as discussed here. Otherwise, LGTM! Thanks for working on that!

@AndersAskeland
Copy link
Member Author

I don't see a commit changing AVISIT from Screening to Baseline for HEIGHT as discussed here. Otherwise, LGTM! Thanks for working on that!

Apparently I got an fatal error on my push attempt - Is up now. Thanks for your comments and review @yurovska .

inst/templates/ad_advs.R Outdated Show resolved Hide resolved
Co-authored-by: Andrii Yurovskyi <[email protected]>
@manciniedoardo
Copy link
Collaborator

@kathrinflunkert @Siddhesh2097 @starosto I will be merging in a few hours. If you have any final notes, please share now, otherwise please approve!

Copy link
Contributor

@kathrinflunkert kathrinflunkert left a comment

Choose a reason for hiding this comment

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

I had no time to follow all the discussions in every detail, but I also could not see anything I don't agree with. ;)

Copy link

@starosto starosto left a comment

Choose a reason for hiding this comment

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

@AndersAskeland besides the comment on the ABLFL, I have no further thoughts. Thanks for a great job 💯

@manciniedoardo manciniedoardo merged commit 1502544 into main Nov 6, 2024
15 checks passed
@manciniedoardo manciniedoardo deleted the 23_advs_template branch November 6, 2024 12:26
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.

Template: ADVS
6 participants