-
-
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
cardx readme update #137
cardx readme update #137
Conversation
Code Coverage Summary
Diff against main
Results for commit: 0a4dd78 Minimum allowed coverage is ♻️ This comment has been updated with latest results |
Unit Tests Summary 1 files 64 suites 10s ⏱️ Results for commit 0a4dd78. ♻️ This comment has been updated with latest results. |
Unit Test Performance Difference
Additional test case details
Results for commit 8a771cf ♻️ This comment has been updated with latest results. |
Merge branch '105_update_readme@main' of github.com:insightsengineering/cardx into 105_update_readme@main # Conflicts: # inst/WORDLIST
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.
Thank you @ayogasekaram !! Can we make a couple small changes?
Signed-off-by: Daniel Sjoberg <danield.sjoberg@gmail.com>
CLA Assistant Lite bot ✅ All contributors have signed the CLA |
I have read the CLA Document and I hereby sign the CLA |
I have read the CLA Document and I hereby sign the CLA |
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.
thank you for making this cute!!
update readme with description
closes #105
Adding installation instructions, brief introduction and summary
Pre-review Checklist (if item does not apply, mark is as complete)
usethis::pr_merge_main()
ard_*()
function was added, it passes the ARD structural checks fromcards::check_ard_structure()
.ard_*()
function was added,set_cli_abort_call()
has been set.ard_*()
function was added and it depends on another package (such as,broom
),is_pkg_installed("broom", reference_pkg = "cardx")
has been set in the function call and the following added to the roxygen comments:@examplesIf do.call(asNamespace("cardx")$is_pkg_installed, list(pkg = "broom"", reference_pkg = "cardx"))
devtools::test_coverage()
Reviewer Checklist (if item does not apply, mark is as complete)
devtools::test_coverage()
When the branch is ready to be merged:
NEWS.md
with the changes from this pull request under the heading "# cardx (development version)
". If there is an issue associated with the pull request, reference it in parentheses at the end update (seeNEWS.md
for examples).