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 #138 Remove docs folder #139

Merged
merged 2 commits into from
May 23, 2023
Merged

Closes #138 Remove docs folder #139

merged 2 commits into from
May 23, 2023

Conversation

averissimo
Copy link
Collaborator

@averissimo averissimo commented May 23, 2023

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

  • Removes doc folder from the root of the directory
  • Remove repetitive lines from .gitignore that reference docs
    • Also removes line with the xportr.Rproj that is committed

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!

@averissimo averissimo changed the title Closes 138 Remove docs folder Closes #138 Remove docs folder May 23, 2023
@averissimo averissimo changed the base branch from main to devel May 23, 2023 16:21
@averissimo averissimo added this to the xportr 0.3.0 milestone May 23, 2023
@averissimo averissimo linked an issue May 23, 2023 that may be closed by this pull request
@codecov
Copy link

codecov bot commented May 23, 2023

Codecov Report

Merging #139 (6fc6b02) into devel (6d644b7) will increase coverage by 27.15%.
The diff coverage is 100.00%.

❗ Current head 6fc6b02 differs from pull request most recent head 7db89db. Consider uploading reports for the commit 7db89db to get more accurate results

@@             Coverage Diff              @@
##            devel      #139       +/-   ##
============================================
+ Coverage   72.84%   100.00%   +27.15%     
============================================
  Files          10        11        +1     
  Lines         372       416       +44     
============================================
+ Hits          271       416      +145     
+ Misses        101         0      -101     
Impacted Files Coverage Δ
R/df_label.R 100.00% <100.00%> (+21.73%) ⬆️
R/format.R 100.00% <100.00%> (+18.75%) ⬆️
R/label.R 100.00% <100.00%> (+21.21%) ⬆️
R/length.R 100.00% <100.00%> (ø)
R/messages.R 100.00% <100.00%> (+43.13%) ⬆️
R/order.R 100.00% <100.00%> (+18.18%) ⬆️
R/support-test.R 100.00% <100.00%> (ø)
R/type.R 100.00% <100.00%> (+10.81%) ⬆️
R/utils-xportr.R 100.00% <100.00%> (+29.78%) ⬆️
R/write.R 100.00% <100.00%> (+16.66%) ⬆️
... and 1 more

@averissimo averissimo marked this pull request as ready for review May 23, 2023 16:36
@elimillera elimillera merged commit acd5b60 into devel May 23, 2023
@elimillera elimillera deleted the 138-remove-docs-folder branch May 23, 2023 17:07
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: Remove the docs folder
2 participants