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 #84 xportr deep dive vignette #141

Merged
merged 96 commits into from
Jun 15, 2023
Merged

Conversation

bms63
Copy link
Collaborator

@bms63 bms63 commented May 24, 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

Vignette can be found here: https://bms63.github.io/xportr/articles/deepdive.html

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!

bms63 added 15 commits May 1, 2023 17:33
Merge remote-tracking branch 'origin/devel' into 84_xportr_deep_dive_vignette
# Please enter a commit message to explain why this merge is necessary,
# especially if it merges an updated upstream into a topic branch.
#
# Lines starting with '#' will be ignored, and an empty message aborts
# the commit.
Merge remote-tracking branch 'origin/devel' into 84_xportr_deep_dive_vignette
# Please enter a commit message to explain why this merge is necessary,
# especially if it merges an updated upstream into a topic branch.
#
# Lines starting with '#' will be ignored, and an empty message aborts
# the commit.
…t label function

Merge remote-tracking branch 'origin/122_update_pkgdown' into 84_xportr_deep_dive_vignette

# Conflicts:
#	_pkgdown.yml
Merge remote-tracking branch 'origin/44-pipe-metadata' into 84_xportr_deep_dive_vignette

# Conflicts:
#	NEWS.md
Merge remote-tracking branch 'origin/devel' into 84_xportr_deep_dive_vignette

# Conflicts:
#	docs/404.html
#	docs/LICENSE-text.html
#	docs/LICENSE.html
#	docs/authors.html
#	docs/index.html
#	docs/pkgdown.yml
vignettes/deepdive.Rmd Outdated Show resolved Hide resolved
@EeethB EeethB linked an issue May 25, 2023 that may be closed by this pull request
@EeethB EeethB requested review from vedhav and kaz462 May 25, 2023 15:42
@bms63
Copy link
Collaborator Author

bms63 commented Jun 15, 2023

Hi all

Updated website: https://bms63.github.io/xportr/

Will fix failing actions tmr. Think we are close - still couple of minor issues to iron with formats, but that might be for next release.

@averissimo
Copy link
Collaborator

averissimo commented Jun 15, 2023

@bms63 and all,

Made a bunch of suggestions for datatables in a separate PR that merges to this one, check it out

Changes:

  • font-weight to 500 instead of bold (middle ground between normal and bold)
  • line-height so that there's no overlap in letters
  • font-size changed to match code size
  • removes row numbers from datatables on xportr vignette (just like the deep dive)
  • fix styler problem
  • fix typo repitition -> repetition

@bms63
Copy link
Collaborator Author

bms63 commented Jun 15, 2023

@atorus-research/xportr-development-team - whew!! this was a big one. TY for all the reviews and code suggestions.

I think this one is good to go now. Unless folks want to take a final peak https://bms63.github.io/xportr/index.html.

I think it will be good to see my version of the website published with the docs updates coming from #148 as well

@bms63 bms63 merged commit 4692171 into devel Jun 15, 2023
10 checks passed
@bms63 bms63 deleted the 84_xportr_deep_dive_vignette branch June 15, 2023 17:25
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: Clean up GET STARTED Page Detailed vignette of how to use xportr
6 participants