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

Adding ard_regression() #26

Merged
merged 13 commits into from
Feb 13, 2024
Merged

Adding ard_regression() #26

merged 13 commits into from
Feb 13, 2024

Conversation

ddsjoberg
Copy link
Collaborator

@ddsjoberg ddsjoberg commented Feb 1, 2024

What changes are proposed in this pull request?

  • Migrated ard_regression() from {cards} and made it an S3 method. I think different types of models classes will need different handling, which is why S3 is a good option here.

Reviewer Checklist (if item does not apply, mark is as complete)

  • Ensure all package dependencies are installed: devtools::install_dev_deps()
  • PR branch has pulled the most recent updates from master branch: usethis::pr_merge_main()
  • If a bug was fixed, a unit test was added.
  • Run pkgdown::build_site(). Check the R console for errors, and review the rendered website.
  • Code coverage is suitable for any new functions/features: devtools::test_coverage()
  • usethis::use_spell_check() runs with no spelling errors in documentation

When the branch is ready to be merged:

  • Update NEWS.md with the changes from this pull request under the heading "# cards (development version)". If there is an issue associated with the pull request, reference it in parentheses at the end update (see NEWS.md for examples).
  • Increment the version number using usethis::use_version(which = "dev")
  • Run usethis::use_spell_check() again
  • Approve Pull Request
  • Merge the PR. Please use "Squash and merge".

Copy link
Contributor

github-actions bot commented Feb 1, 2024

badge

Code Coverage Summary

Filename                 Stmts    Miss  Cover    Missing
---------------------  -------  ------  -------  ------------------------------------
R/ard_chisqtest.R           31       0  100.00%
R/ard_fishertest.R          33       0  100.00%
R/ard_proportion_ci.R       40       5  87.50%   63-67
R/ard_regression.R          49       0  100.00%
R/ard_ttest.R               78       0  100.00%
R/ard_wilcoxtest.R          83       0  100.00%
R/proportion_ci.R          182      28  84.62%   241, 244, 253-258, 266, 281, 381-404
TOTAL                      496      33  93.35%

Diff against main

Filename              Stmts    Miss  Cover
------------------  -------  ------  --------
R/ard_regression.R      +49       0  +100.00%
TOTAL                   +49       0  +0.73%

Results for commit: 92af0b3

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Contributor

github-actions bot commented Feb 1, 2024

Unit Tests Summary

 1 files  12 suites   1s ⏱️
12 tests  8 ✅ 4 💤 0 ❌
23 runs  16 ✅ 7 💤 0 ❌

Results for commit 92af0b3.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Feb 1, 2024

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
ard_regression 👶 $+0.08$ $+1$ $+1$ $0$ $0$
Additional test case details
Test Suite $Status$ Time on main $±Time$ Test Case
ard_regression 👶 $+0.08$ ard_regression_works

Results for commit e02ec4f

♻️ This comment has been updated with latest results.

@edelarua edelarua self-requested a review February 13, 2024 17:07
Copy link
Contributor

@edelarua edelarua left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Just a few suggestions to link the mentioned functions within the documentation. Then it should be good to go :)

R/ard_regression.R Outdated Show resolved Hide resolved
R/ard_regression.R Show resolved Hide resolved
@ddsjoberg ddsjoberg merged commit 8b4f7cf into main Feb 13, 2024
22 checks passed
@ddsjoberg ddsjoberg deleted the ard_regression branch February 13, 2024 23:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants