Function Documentation ReDo

[elimillera]

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

Draft for now while I work through all of the updates

Good number of updates to functions:

• Updated the params to inherit from a single spot where possible
• Added Metadata and messaging sections for each function.
• Added options documentation on package help page

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!

[codecov]

Codecov Report

Merging #148 (c3f95a4) into devel (39ba88e) will increase coverage by 1.39%.
The diff coverage is 100.00%.

❗ Current head c3f95a4 differs from pull request most recent head 09d4474. Consider uploading reports for the commit 09d4474 to get more accurate results

@@             Coverage Diff             @@
##            devel      #148      +/-   ##
===========================================
+ Coverage   98.60%   100.00%   +1.39%     
===========================================
  Files          11        12       +1     
  Lines         429       475      +46     
===========================================
+ Hits          423       475      +52     
+ Misses          6         0       -6     

Impacted Files	Coverage Δ
R/support-test.R	100.00% <ø> (ø)
R/df_label.R	100.00% <100.00%> (ø)
R/format.R	100.00% <100.00%> (ø)
R/label.R	100.00% <100.00%> (ø)
R/length.R	100.00% <100.00%> (ø)
R/messages.R	100.00% <100.00%> (ø)
R/metadata.R	100.00% <100.00%> (ø)
R/order.R	100.00% <100.00%> (ø)
R/type.R	100.00% <100.00%> (ø)
R/utils-xportr.R	100.00% <100.00%> (+5.08%)	⬆️
... and 1 more

[bms63]

Is this branched off of the main branch rather than devel?

[elimillera]

Is this branched off of the main branch rather than devel?

It wasn't but it looks like a git merge went wrong and merged in what we have from main

[bms63]

Awesome!! This feels like a real package now with proper documentation

I like the use of inheritParams to minimize updating the params.

Notes

• I think we should have examples that showcase the messages or warnings for each function - this is nice to see in action.

• We references a lot of the options usage in the documentation. I think we should link out to the deep-dive.Rmd for users to learn more about the options.

• We should avoid the use of value level metadata as it means something different for ADaM programming. I find it a confusing term. We should use just metadata or metadata object.