-
Notifications
You must be signed in to change notification settings - Fork 2
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
Add get sql function #68
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rmbielby
requested changes
Mar 11, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mainly just a few minor tweaks to the text.
rmbielby
approved these changes
Mar 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Brief overview of changes
Add a get_clean_sql function to resolve #55, and details on code coverage setup to resolve #53.
This increases the package version to 0.2.0.
Why are these changes being made?
This function is used across lots of DfE projects already. Other bits of tidy up to resolve known issues with documentation.
Detailed description of changes
Updates to contributing page:
usethis::use_test()
lintr::lint_package()
Updates to package documentation:
Added
get_clean_sql()
function, documentation and tests. Includes a sample SQL script to test with.Added vignette for connecting to SQL to give more user friendly context for
get_clean_sql()
.Bumping package version to 0.2.0 for this and #59.
Added note to README pointing to the reference documentation for the package.
Additional information for reviewers
I will squash the commits when merging as I got into a slight mess with git rebase conflicts that seems to have duplicated commits in the commit history.
I'll reflect any changes here in Fix typo and update guidance to point to dfeR package analysts-guide#43 to update the relevant section of the Analysts' Guide.
Issue ticket number/s and link
#55, #53.