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

Closes #133 proliferate conf.level argument as appropriate across package #142

Merged
merged 3 commits into from
May 3, 2024

Conversation

zdz2101
Copy link
Contributor

@zdz2101 zdz2101 commented May 2, 2024

What changes are proposed in this pull request?
Adds conf.level argument to variety of functions for consistency

Provide more detail here as needed.

Closes #133


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".

@zdz2101 zdz2101 requested a review from ddsjoberg May 2, 2024 17:42
@zdz2101 zdz2101 linked an issue May 2, 2024 that may be closed by this pull request
Copy link
Contributor

github-actions bot commented May 2, 2024

CLA Assistant Lite bot ✅ All contributors have signed the CLA

@zdz2101
Copy link
Contributor Author

zdz2101 commented May 2, 2024

I have read the CLA Document and I hereby sign the CLA

Copy link
Contributor

github-actions bot commented May 2, 2024

badge

Code Coverage Summary

Filename                           Stmts    Miss  Cover    Missing
-------------------------------  -------  ------  -------  ------------------------------------
R/ard_aod_wald_test.R                 77       8  89.61%   36-41, 91, 94
R/ard_car_anova.R                     45       2  95.56%   62, 65
R/ard_car_vif.R                       61       2  96.72%   52, 86
R/ard_effectsize_cohens_d.R           90       2  97.78%   68, 114
R/ard_effectsize_hedges_g.R           84       2  97.62%   68, 119
R/ard_emmeans_mean_difference.R       70       0  100.00%
R/ard_proportion_ci.R                 42       5  88.10%   68-72
R/ard_regression_basic.R              16       1  93.75%   46
R/ard_regression.R                    51       0  100.00%
R/ard_smd_smd.R                       55       1  98.18%   48
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.R                 111       2  98.20%   65, 111
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_svycontinuous.R         193       2  98.96%   169, 179
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.R             180       8  95.56%   79-81, 85, 95-97, 247
R/construction_helpers.R              57       6  89.47%   143, 155-159
R/proportion_ci.R                    194      28  85.57%   290, 293, 302-307, 315, 330, 431-454
TOTAL                               2147      79  96.32%

Diff against main

Filename                       Stmts    Miss  Cover
---------------------------  -------  ------  -------
R/ard_effectsize_cohens_d.R       +2       0  +0.05%
R/ard_effectsize_hedges_g.R       +2       0  +0.06%
R/ard_stats_fisher_test.R         +1       0  +0.06%
R/ard_stats_prop_test.R           +2       0  +0.03%
R/ard_stats_t_test.R              +1       0  +0.02%
R/ard_stats_wilcox_test.R         +1       0  +0.02%
TOTAL                             +9       0  +0.02%

Results for commit: 0d415ff

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Contributor

github-actions bot commented May 2, 2024

Unit Tests Summary

  1 files   64 suites   10s ⏱️
 64 tests  44 ✅ 20 💤 0 ❌
181 runs  149 ✅ 32 💤 0 ❌

Results for commit 108edfd.

Copy link
Contributor

github-actions bot commented May 2, 2024

Unit Tests Summary

  1 files   64 suites   9s ⏱️
 64 tests  44 ✅ 20 💤 0 ❌
181 runs  149 ✅ 32 💤 0 ❌

Results for commit 0d415ff.

♻️ This comment has been updated with latest results.

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.

This looks great. Can we add the check_range(conf.level, range = c(0, 1)) check for the function we've added this to? Thanks!

@ddsjoberg
Copy link
Collaborator

This looks great. Can we add the check_range(conf.level, range = c(0, 1)) check for the function we've added this to? Thanks!

I just added them so we could merge! Have a great weekend!!

@ddsjoberg ddsjoberg merged commit 817694d into main May 3, 2024
31 checks passed
@ddsjoberg ddsjoberg deleted the 133-use-consistent-conflevel-argument branch May 3, 2024 23:24
@github-actions github-actions bot locked and limited conversation to collaborators May 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use consistent conf.level argument
2 participants