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 #2609: added duplicates example to derive_vars_transposed() #2663

Merged
merged 10 commits into from
Mar 21, 2025

Conversation

manciniedoardo
Copy link
Collaborator

@manciniedoardo manciniedoardo commented Feb 18, 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!

Copy link

github-actions bot commented Feb 18, 2025

Code Coverage

Package Line Rate Health
admiral 98%
Summary 98% (5316 / 5421)

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.

I think we should provide more details in the documentation:

  • For id_vars:

    "Variables (excluding by_vars) that uniquely identify each observation in dataset_merge."

    should be updated to

    "Variables (excluding by_vars and key_var) that uniquely identify each observation in dataset_merge.

  • The "Details" section should be extended such that the steps (transposing and merging) are explained. It should also mentioned that the function in contrast to other derive_vars_*() functions may add records to the input dataset.

Copy link

github-actions bot commented Mar 6, 2025

This Pull Request is stale because it has not been worked on in 15 days.

@github-actions github-actions bot added the stale label Mar 6, 2025
@manciniedoardo
Copy link
Collaborator Author

@bms63 @bundfussr I have implemented the review comments. Please read through the new @details section to see if anything can be changed/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.

details are looking good to me. just a note in the example

@bms63
Copy link
Collaborator

bms63 commented Mar 21, 2025

@manciniedoardo Can we specify the argument here and in the other exmaples just so the error message is clear on where it is happening
image

Thanks again for jumping on this one!!!

@manciniedoardo manciniedoardo requested a review from bms63 March 21, 2025 08:40
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 am a happy camper!! 😄

@bundfussr any thoughts or can we merge in?

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.

Looks good except one typo.

…b.com:pharmaverse/admiral into 2609_derive_vars_transposed_duplicate_example
@manciniedoardo manciniedoardo merged commit e061fde into main Mar 21, 2025
19 checks passed
@manciniedoardo manciniedoardo deleted the 2609_derive_vars_transposed_duplicate_example branch March 21, 2025 14:11
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: derive_var_transposed() showcase in Examples what error looks like for duplicates
3 participants