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 #271 add_hms: add hms to xportr.numeric_types and add details to xpor… #277

Merged
merged 3 commits into from
Nov 26, 2024

Conversation

bundfussr
Copy link
Collaborator

@bundfussr bundfussr commented Nov 14, 2024

…tr_type() messages

Thank you for your Pull Request!

We have developed a Pull Request template to aid you and our reviewers. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the xportr codebase remains robust and consistent.

The scope of {xportr}

{xportr}'s scope is to enable R users to write out submission compliant xpt files that can be delivered to a Health Authority or to downstream validation software programs. We see labels, lengths, types, ordering and formats from a dataset specification object (SDTM and ADaM) as being our primary focus. We also see messaging and warnings to users around applying information from the specification file as a primary focus. Please make sure your Pull Request meets this scope of {xportr}. If your Pull Request moves beyond this scope, please get in touch with the {xportr} team on slack or create an issue to discuss.

Please check off each task box as an acknowledgment that you completed the task. 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.

Changes Description

  • "hms" added to xportr.numeric_types option
  • More details added to messages of xportr_type()

Task List

  • The spirit of xportr is met in your Pull Request
  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
  • Summary of changes filled out in the above Changes Description. Can be removed or left blank if changes are minor/self-explanatory.
  • Code is formatted according to the tidyverse style guide. Use styler package and functions to style files accordingly.
  • New functions or arguments follow established convention found in the Wiki.
  • Updated relevant unit tests or have written new unit tests. See our Wiki for conventions used in this package.
  • Creation/updated relevant roxygen headers and examples. See our Wiki for conventions used in this package.
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Run pkgdown::build_site() and check that all affected examples are displayed correctly and that all new/updated functions occur on the "Reference" page.
  • Update NEWS.md if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers)
  • The NEWS.md entry should go under the # xportr development version section. Don't worry about updating the version because it will be auto-updated using the vbump.yaml CI.
  • Address any updates needed for vignettes and/or templates.
  • Link the issue Development Panel so that it closes after successful merging.
  • The developer is responsible for fixing merge conflicts not the Reviewer.
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

Copy link

github-actions bot commented Nov 14, 2024

Code Coverage

Package Line Rate Health
xportr 100%
Summary 100% (865 / 866)

@bundfussr bundfussr linked an issue Nov 14, 2024 that may be closed by this pull request
@bundfussr bundfussr requested a review from bms63 November 14, 2024 17:06
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 is on my list. Can you take a peak at my code in the issue you posted. I feel like I am missing something there

Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this a good opportunity for some snapshot testing with all these additional messages? We can make into separate issue to move this along

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think this would make sense. I've added no snapshot tests for the new messages because snapshot testing is not used in xportr so far.

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.

@elimillera can you also review please. I don't have much to add but nice to have maintainer look over

Copy link
Member

@elimillera elimillera left a comment

Choose a reason for hiding this comment

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

updates looks great. Thank you!

@elimillera elimillera merged commit 850d5cb into main Nov 26, 2024
15 checks passed
@elimillera elimillera deleted the 271_add_hms branch November 26, 2024 01:47
@bundfussr
Copy link
Collaborator Author

@elimillera , @bms63 , when will be the next xportr release?

@bms63
Copy link
Collaborator

bms63 commented Nov 26, 2024

We found @elimillera :) Yay!

Can we push an update to CRAN @elimillera? I can prepare xportr for a CRAN release if you can post to CRAN

@elimillera
Copy link
Member

@bms63 You bet. Yep Looking to get back on top of my Open source projects so I think we can do a release now as I work on more updates to close issues

@bundfussr
Copy link
Collaborator Author

We found @elimillera :) Yay!

Can we push an update to CRAN @elimillera? I can prepare xportr for a CRAN release if you can post to CRAN

@bms63 , @elimillera , it is not urgent to release to CRAN but it would be nice to have a xportr release around the time when admiral is released (beginning of January). We will release admiralroche mid or end of January. If xportr is released until then, we could update the admiralroche templates to use the new functionality.

@bms63
Copy link
Collaborator

bms63 commented Nov 26, 2024

Awesome - I think we should be able to get this out in the next couple of weeks then.

Perhaps @elimillera we can tighten up a few examples and vignettes.

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: Add "hms" to xportr.numeric_types
3 participants