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 120 - Replace metacore with metadata #134

Merged
merged 14 commits into from
Jun 1, 2023

Conversation

vedhav
Copy link
Collaborator

@vedhav vedhav commented May 23, 2023

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 devel branch until you have checked off each task.

Changes Description

  1. Replaces the metacore with metadata across all the xportr functions
  2. Provide deprecation message for the users
  3. Set up deprecation badges for future deprecation by running usethis::use_lifecycle()

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.
  • Check that your Pull Request is targeting the devel branch, Pull Requests to main should use the Release Pull Request Template
  • Code is formatted according to the tidyverse style guide. Use styler package and functions to style files accordingly.
  • 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)
  • Address any updates needed for vignettes and/or templates
  • Link the issue Development Panel so that it closes after successful merging.
  • Fix merge conflicts
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

NEWS.md Outdated Show resolved Hide resolved
R/df_label.R Outdated Show resolved Hide resolved
R/format.R Outdated Show resolved Hide resolved
R/label.R Outdated Show resolved Hide resolved
R/length.R Outdated Show resolved Hide resolved
R/order.R Outdated Show resolved Hide resolved
R/type.R Outdated Show resolved Hide resolved
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.

Looking good! Just a few minor comments

@bms63
Copy link
Collaborator

bms63 commented May 24, 2023

Is it possible to drop the docs folder or merge in Andre's removal of docs. Looks like the link checker is falling over from the docs as well as the merge conflicts

vedhav and others added 2 commits May 25, 2023 21:09
Co-authored-by: Ben Straub <ben.x.straub@gsk.com>
Co-authored-by: Ben Straub <ben.x.straub@gsk.com>
@EeethB EeethB self-requested a review May 25, 2023 15:43
…-with-metadata

# Conflicts:
#	docs/404.html
#	docs/LICENSE-text.html
#	docs/LICENSE.html
#	docs/articles/index.html
#	docs/articles/xportr.html
#	docs/articles/xportr_files/datatables-css-0.0.0/datatables-crosstalk.css
#	docs/authors.html
#	docs/index.html
#	docs/news/index.html
#	docs/pkgdown.js
#	docs/pkgdown.yml
#	docs/reference/index.html
#	docs/reference/xportr-package.html
#	docs/reference/xportr_df_label.html
#	docs/reference/xportr_format.html
#	docs/reference/xportr_label.html
#	docs/reference/xportr_length.html
#	docs/reference/xportr_order.html
#	docs/reference/xportr_type.html
#	docs/reference/xportr_write.html
…-with-metadata

# Conflicts:
#	R/df_label.R
#	R/format.R
#	R/label.R
#	R/length.R
#	R/order.R
#	R/type.R
#	man/xportr_df_label.Rd
#	man/xportr_format.Rd
#	man/xportr_label.Rd
#	man/xportr_length.Rd
#	man/xportr_order.Rd
#	man/xportr_type.Rd
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.

LGTM

@elimillera elimillera merged commit 678fe9e into devel Jun 1, 2023
@elimillera elimillera deleted the 120-replace-metacore-with-metadata branch June 1, 2023 15:34
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.

Updating metacore argument to metadata and establishing process for deprecating metacore
3 participants