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 #116 Check for other package messaging in our snapshots #125

Merged
merged 6 commits into from
Apr 25, 2024

Conversation

zdz2101
Copy link
Contributor

@zdz2101 zdz2101 commented Apr 18, 2024

What changes are proposed in this pull request?
Check and remove snapshots that contain other-package messaging

Provide more detail here as needed.

Closes #116


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 linked an issue Apr 18, 2024 that may be closed by this pull request
@zdz2101 zdz2101 changed the title fix old mistake Closes #116 Check for other package messaging in our snapshots Apr 18, 2024
@zdz2101
Copy link
Contributor Author

zdz2101 commented Apr 18, 2024

@ddsjoberg Didn't quite find any error-out messages in our snapshots, but as for other package's error messaging is this an example? For the ones where we collect the message into the error column of the ard?

image

@zdz2101
Copy link
Contributor Author

zdz2101 commented Apr 18, 2024

otherwise I fixed an unintended mistake from my old PR

@ddsjoberg
Copy link
Collaborator

Thanks @zdz2101 ! This is exactly what we're looking for

image

@zdz2101
Copy link
Contributor Author

zdz2101 commented Apr 18, 2024

@ddsjoberg Would the resolution be to not include the error column in the snapshot? and for the snapshots where it says "2 more variables: warning, error" do those need to be checked as well for said errors?

@ddsjoberg
Copy link
Collaborator

@ddsjoberg Would the resolution be to not include the error column in the snapshot? and for the snapshots where it says "2 more variables: warning, error" do those need to be checked as well for said errors?

Hi @zdz2101 , Let's check that an error exists, but not its precise language, so that we don't induce a breaking change if another package changes its error message.

@zdz2101 zdz2101 marked this pull request as ready for review April 25, 2024 17:24
@zdz2101 zdz2101 requested a review from ddsjoberg April 25, 2024 17:26
Copy link
Contributor

github-actions bot commented Apr 25, 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           88       2  97.73%   66, 111
R/ard_effectsize_hedges_g.R           82       2  97.56%   65, 115
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             41       1  97.56%   39
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             31       0  100.00%
R/ard_stats_prop_test.R               82       1  98.78%   40
R/ard_stats_t_test.R                 110       2  98.18%   62, 108
R/ard_stats_wilcox_test.R             97       2  97.94%   62, 114
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                               2131      79  96.29%

Diff against main

Filename           Stmts    Miss  Cover
---------------  -------  ------  -------
R/ard_car_vif.R        0      -4  +6.56%
TOTAL                  0      -4  +0.19%

Results for commit: 8d8bc86

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Contributor

github-actions bot commented Apr 25, 2024

Unit Tests Summary

  1 files   63 suites   9s ⏱️
 63 tests  44 ✅ 19 💤 0 ❌
180 runs  149 ✅ 31 💤 0 ❌

Results for commit 8d8bc86.

♻️ 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.

awesome, thank you for the update @zdz2101 !!!

@ddsjoberg ddsjoberg merged commit a95e091 into main Apr 25, 2024
27 checks passed
@ddsjoberg ddsjoberg deleted the 116-check-for-other-package-messaging branch April 25, 2024 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Check for other package messaging found in our snapshots
2 participants