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.

Sign up for GitHub

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

Jump to bottom

Add ard_stats_mantelhaen_test() #246

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Add ard_stats_mantelhaen_test() #246

wants to merge 10 commits into from
+363 −0

Conversation

edelarua
Copy link
Contributor

What changes are proposed in this pull request?

Closes #238

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") 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""))
  • 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 Nov 30, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 30, 2024 •
edited
Loading

Unit Tests Summary

  1 files  162 suites   1m 7s ⏱️
160 tests 160 ✅ 0 💤 0 ❌
666 runs  666 ✅ 0 💤 0 ❌

Results for commit 024a97d.

♻️ This comment has been updated with latest results.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 30, 2024 •
edited
Loading

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
ard_stats_mantelhaen_test 👶 $+0.00$ $+1$ $0$ $0$ $0$
Additional test case details
Test Suite $Status$ Time on main $±Time$ Test Case
ard_continuous.survey.design 💚 $18.08$ $-5.54$ unstratified_ard_continuous.survey.design_works
ard_stats_mantelhaen_test 👶 $+0.00$ ard_stats_mantelhaen_test.array_works
ard_stats_mantelhaen_test 👶 $+0.48$ ard_stats_mantelhaen_test.data.frame_works
ard_stats_mantelhaen_test 👶 $+0.00$ ard_stats_mantelhaen_test_follows_ard_structure
ard_survival_survfit 💔 $1.52$ $+1.03$ ard_survival_survfit_works_with_times_provided
construction_helpers 💔 $0.41$ $+1.88$ construct_model_works
proportion_ci 💔 $0.14$ $+1.47$ check_the_proportion_ci__functions_work

Results for commit de1a4cb

♻️ This comment has been updated with latest results.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 30, 2024 •
edited
Loading

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                      77       8  89.61%   38-43, 93, 96
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                            62       1  98.39%   87
R/ard_categorical_ci.R                     96       1  98.96%   83
R/ard_categorical_ci.survey.design.R      129       1  99.22%   180
R/ard_categorical.survey.design.R         393       8  97.96%   77, 228-231, 275, 517, 531
R/ard_continuous_ci.R                      28       1  96.43%   38
R/ard_continuous_ci.survey.design.R       138       0  100.00%
R/ard_continuous.survey.design.R          274      14  94.89%   86, 177, 187, 338, 369-370, 418-426
R/ard_dichotomous.survey.design.R          73       3  95.89%   51, 156, 161
R/ard_effectsize_cohens_d.R               103       2  98.06%   69, 122
R/ard_effectsize_hedges_g.R                91       2  97.80%   68, 120
R/ard_emmeans_mean_difference.R            70       0  100.00%
R/ard_missing.survey.design.R              82       1  98.78%   52
R/ard_regression_basic.R                   16       1  93.75%   46
R/ard_regression.R                         73       0  100.00%
R/ard_smd_smd.R                            69       5  92.75%   57, 83-86
R/ard_stats_anova.R                        95       0  100.00%
R/ard_stats_aov.R                          46       0  100.00%
R/ard_stats_chisq_test.R                   40       1  97.50%   39
R/ard_stats_fisher_test.R                  43       1  97.67%   42
R/ard_stats_kruskal_test.R                 36       1  97.22%   38
R/ard_stats_mantelhaen_test.R             103       1  99.03%   68
R/ard_stats_mcnemar_test.R                 80       2  97.50%   63, 106
R/ard_stats_mood_test.R                    49       1  97.96%   45
R/ard_stats_oneway_test.R                  39       0  100.00%
R/ard_stats_poisson_test.R                 76       1  98.68%   59
R/ard_stats_prop_test.R                    85       1  98.82%   43
R/ard_stats_t_test_onesample.R             41       0  100.00%
R/ard_stats_t_test.R                      112       2  98.21%   65, 111
R/ard_stats_wilcox_test_onesample.R        42       0  100.00%
R/ard_stats_wilcox_test.R                  99       2  97.98%   65, 117
R/ard_survey_svychisq.R                    38       1  97.37%   44
R/ard_survey_svyranktest.R                 54       1  98.15%   44
R/ard_survey_svyttest.R                    53       1  98.11%   42
R/ard_survival_survdiff.R                  89       0  100.00%
R/ard_survival_survfit_diff.R              76       0  100.00%
R/ard_survival_survfit.R                  197       5  97.46%   211-215
R/construction_helpers.R                  106      10  90.57%   160-175, 189, 248
R/proportion_ci.R                         195       1  99.49%   454
TOTAL                                    3627      82  97.74%

Diff against main

Filename                         Stmts    Miss  Cover
-----------------------------  -------  ------  -------
R/ard_stats_mantelhaen_test.R     +103      +1  +99.03%
TOTAL                             +103      +1  +0.04%

Results for commit: 024a97d

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

@ddsjoberg
Copy link
Collaborator

Let's update to use cards::as_card_fn() and let's use this new function as a template for how we recommend new ard functions be written...perhaps convert to a mini article?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
sme
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add ARD functions to perform difference tests for two proportions
2 participants
@edelarua @ddsjoberg