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

Add warning and error columns to ard_regression() output #195

Merged
merged 13 commits into from
Aug 21, 2024

Conversation

edelarua
Copy link
Contributor

@edelarua edelarua commented Aug 12, 2024

What changes are proposed in this pull request?

Closes #148


Pre-review Checklist (if item does not apply, mark is as complete)

  • All GitHub Action workflows pass with a ✅
  • 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.
  • If a new ard_*() function was added, it passes the ARD structural checks from cards::check_ard_structure().
  • If a new ard_*() function was added, set_cli_abort_call() has been set.
  • If a new 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"))
  • Code coverage is suitable for any new functions/features (generally, 100% coverage for new code): devtools::test_coverage()

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

  • If a bug was fixed, a unit test was added.
  • Code coverage is suitable for any new functions/features: devtools::test_coverage()

When the branch is ready to be merged:

  • Update 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 (see NEWS.md for examples).
  • All GitHub Action workflows pass with a ✅
  • Approve Pull Request
  • Merge the PR. Please use "Squash and merge" or "Rebase and merge".

@edelarua edelarua added the sme label Aug 12, 2024
Copy link
Contributor

github-actions bot commented Aug 12, 2024

Unit Tests Summary

  1 files  102 suites   1m 1s ⏱️
102 tests  70 ✅ 32 💤 0 ❌
494 runs  450 ✅ 44 💤 0 ❌

Results for commit 0ec71d7.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Aug 12, 2024

Unit Test Performance Difference

Additional test case details
Test Suite $Status$ Time on main $±Time$ Test Case
ard_regression 👶 $+0.00$ ard_regression_warnings_and_errors_return_correctly

Results for commit 1761a59

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Aug 12, 2024

badge

Code Coverage Summary

Filename                                Stmts    Miss  Cover    Missing
------------------------------------  -------  ------  -------  ---------------------------------------------------------------------------
R/add_total_n.survey.design.R              12       0  100.00%
R/ard_aod_wald_test.R                      78       8  89.74%   39-44, 94, 97
R/ard_attributes.survey.design.R            2       0  100.00%
R/ard_car_anova.R                          45       2  95.56%   62, 65
R/ard_car_vif.R                            61       2  96.72%   52, 86
R/ard_categorical_ci.R                     93       5  94.62%   128-132
R/ard_categorical_ci.survey.design.R      127       3  97.64%   150-151, 177
R/ard_categorical.survey.design.R         392      13  96.68%   76, 102, 129-132, 229-232, 276, 518, 532
R/ard_continuous_ci.R                      24       0  100.00%
R/ard_continuous_ci.survey.design.R       136       4  97.06%   55-57, 206
R/ard_continuous.survey.design.R          201       3  98.51%   86, 177, 187
R/ard_dichotomous.survey.design.R          73       3  95.89%   51, 156, 161
R/ard_effectsize_cohens_d.R               102       2  98.04%   68, 121
R/ard_effectsize_hedges_g.R                90       2  97.78%   68, 120
R/ard_emmeans_mean_difference.R            70       0  100.00%
R/ard_missing.survey.design.R              77       0  100.00%
R/ard_regression_basic.R                   16       1  93.75%   46
R/ard_regression.R                         73       0  100.00%
R/ard_smd_smd.R                            68       5  92.65%   58, 84-87
R/ard_stats_anova.R                        95       0  100.00%
R/ard_stats_aov.R                          36       0  100.00%
R/ard_stats_chisq_test.R                   39       1  97.44%   39
R/ard_stats_fisher_test.R                  42       1  97.62%   42
R/ard_stats_kruskal_test.R                 35       1  97.14%   38
R/ard_stats_mcnemar_test.R                 79       2  97.47%   63, 105
R/ard_stats_mood_test.R                    48       1  97.92%   46
R/ard_stats_oneway_test.R                  38       0  100.00%
R/ard_stats_prop_test.R                    84       1  98.81%   43
R/ard_stats_t_test_onesample.R             40       0  100.00%
R/ard_stats_t_test.R                      111       2  98.20%   65, 111
R/ard_stats_wilcox_test_onesample.R        41       0  100.00%
R/ard_stats_wilcox_test.R                  98       2  97.96%   65, 117
R/ard_survey_svychisq.R                    37       1  97.30%   44
R/ard_survey_svyranktest.R                 51       0  100.00%
R/ard_survey_svyttest.R                    50       0  100.00%
R/ard_survival_survdiff.R                  89       0  100.00%
R/ard_survival_survfit_diff.R              76       8  89.47%   31-34, 43-46
R/ard_survival_survfit.R                  174      13  92.53%   79-81, 85, 95-97, 128-132, 237
R/construction_helpers.R                  105      39  62.86%   101-104, 107-111, 143-146, 149-153, 164-169, 192, 204-208, 234-238, 245-249
R/proportion_ci.R                         195      28  85.64%   290, 293, 302-307, 315, 330, 438-461
TOTAL                                    3303     153  95.37%

Diff against main

Filename              Stmts    Miss  Cover
------------------  -------  ------  --------
R/ard_regression.R      +22       0  +100.00%
TOTAL                   +22       0  +0.03%

Results for commit: 0ec71d7

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

@edelarua edelarua requested a review from ddsjoberg August 20, 2024 00:22
Copy link
Collaborator

@ddsjoberg ddsjoberg left a comment

Choose a reason for hiding this comment

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

@edelarua thank you for adding this! it looks great!

Just one comment on the way to set options in testthat files.

tests/testthat/test-ard_regression.R Outdated Show resolved Hide resolved
@edelarua edelarua requested a review from ddsjoberg August 21, 2024 19:01
@@ -1,6 +1,8 @@
skip_if_not(do.call(asNamespace("cardx")$is_pkg_installed, list(pkg = "broom.helpers", reference_pkg = "cardx")))

test_that("ard_regression_basic() works", {
options(width = 100)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we should be good to merge after we update this one with the withr function.

When you make this update, can you also update the NEWS and I'll merge?

Copy link
Collaborator

@ddsjoberg ddsjoberg left a comment

Choose a reason for hiding this comment

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

Thank you @edelarua !!

@ddsjoberg ddsjoberg merged commit bcbd89a into main Aug 21, 2024
33 checks passed
@ddsjoberg ddsjoberg deleted the 148_warn_error_regression@main branch August 21, 2024 20:02
@github-actions github-actions bot locked and limited conversation to collaborators Aug 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add error and warning columns to ard_regression()
2 participants