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

Making ard_survey_svycontinuous() a S3 method #150

Merged
merged 6 commits into from
May 22, 2024

Conversation

ddsjoberg
Copy link
Collaborator

@ddsjoberg ddsjoberg commented May 14, 2024

What changes are proposed in this pull request?
Converted ard_survey_svycontinuous() to a S3 method ard_continuous.survey.design().


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

@ddsjoberg ddsjoberg changed the title Making tbl_survey_svycontinuous a S3 method Making ard_survey_svycontinuous() a S3 method May 14, 2024
Copy link
Contributor

Unit Tests Summary

  1 files   57 suites   9s ⏱️
 57 tests  39 ✅ 18 💤 0 ❌
148 runs  119 ✅ 29 💤 0 ❌

Results for commit 4419876.

Copy link
Contributor

github-actions bot commented May 14, 2024

Unit Tests Summary

  1 files   65 suites   10s ⏱️
 65 tests  44 ✅ 21 💤 0 ❌
182 runs  149 ✅ 33 💤 0 ❌

Results for commit 0beacc7.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented May 14, 2024

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
ard_attributes.survey.design 👶 $+0.40$ $+1$ $+1$ $0$ $0$
ard_continuous.survey.design 👶 $+0.01$ $+2$ $0$ $0$ $0$
ard_survey_svycontinuous 💀 $0.01$ $-0.01$ $-2$ $0$ $0$ $0$
Additional test case details
Test Suite $Status$ Time on main $±Time$ Test Case
ard_attributes.survey.design 👶 $+0.40$ ard_attributes.survey.design_works
ard_continuous.survey.design 👶 $+0.01$ ard_continuous.survey.design_NA_handling
ard_continuous.survey.design 👶 $+0.01$ ard_continuous.survey.design_by_unobserved_levels_combinations
ard_continuous.survey.design 👶 $+0.00$ ard_continuous.survey.design_error_handling
ard_continuous.survey.design 👶 $+0.00$ ard_continuous.survey.design_fmt_fn_
ard_continuous.survey.design 👶 $+0.01$ ard_continuous.survey.design_stat_label_
ard_continuous.survey.design 👶 $+0.03$ stratified_ard_continuous.survey.design_works
ard_continuous.survey.design 👶 $+0.61$ unstratified_ard_continuous.survey.design_works
ard_survey_svycontinuous 💀 $0.01$ $-0.01$ ard_survey_svycontinuous_NA_handling
ard_survey_svycontinuous 💀 $0.01$ $-0.01$ ard_survey_svycontinuous_by_unobserved_levels_combinations
ard_survey_svycontinuous 💀 $0.00$ $-0.00$ ard_survey_svycontinuous_error_handling
ard_survey_svycontinuous 💀 $0.00$ $-0.00$ ard_survey_svycontinuous_fmt_fn_
ard_survey_svycontinuous 💀 $0.01$ $-0.01$ ard_survey_svycontinuous_stat_label_
ard_survey_svycontinuous 💀 $0.02$ $-0.02$ stratified_ard_survey_svycontinuous_works
ard_survey_svycontinuous 💀 $0.85$ $-0.85$ unstratified_ard_survey_svycontinuous_works

Results for commit 41496a2

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented May 14, 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_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_continuous.survey.design.R      194       2  98.97%   172, 182
R/ard_effectsize_cohens_d.R           102       2  98.04%   68, 121
R/ard_effectsize_hedges_g.R            97       2  97.94%   68, 127
R/ard_emmeans_mean_difference.R        70       0  100.00%
R/ard_proportion_ci.R                  42       5  88.10%   68-72
R/ard_regression.R                     51       0  100.00%
R/ard_regression_basic.R               16       1  93.75%   46
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.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_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               60       6  90.00%   148, 160-164
R/proportion_ci.R                     194      28  85.57%   290, 293, 302-307, 315, 330, 431-454
TOTAL                                2191      83  96.21%

Diff against main

Filename                            Stmts    Miss  Cover
--------------------------------  -------  ------  --------
R/ard_attributes.survey.design.R       +2       0  +100.00%
R/ard_continuous.survey.design.R     +194      +2  +98.97%
TOTAL                                +196      +2  +0.01%

Results for commit: 0beacc7

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Contributor

@ayogasekaram ayogasekaram 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 Daniel! I'll update the categorical function into an s3 method as well :)

@ddsjoberg ddsjoberg merged commit 3973772 into main May 22, 2024
31 checks passed
@ddsjoberg ddsjoberg deleted the ard_svycontinuous-to-S3 branch May 22, 2024 21:04
@github-actions github-actions bot locked and limited conversation to collaborators May 22, 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.

2 participants