review protected names and add tests

ayogasekaram commented 2 months ago

found more protected names through testing
Added expect_equal tests to ensure other variables names work as expected
Updated error messaging to include new variables

What changes are proposed in this pull request?

Style this entry in a way that can be copied directly into NEWS.md. (#, @)

Provide more detail here as needed.

Reference GitHub issue associated with pull request. e.g., 'closes #'

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

[ ] All GitHub Action workflows pass with a :white_check_mark:
[ ] 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 :white_check_mark:
[ ] Approve Pull Request
[ ] Merge the PR. Please use "Squash and merge" or "Rebase and merge".

github-actions[bot] commented 2 months ago

Unit Tests Summary

1 files 98 suites 1m 0s :stopwatch: 98 tests 68 :white_check_mark: 30 :zzz: 0 :x: 490 runs 448 :white_check_mark: 42 :zzz: 0 :x:

Results for commit 0dde406a.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 2 months ago

Unit Test Performance Difference

Additional test case details

| Test Suite | $Status$ | Time on `main` | $±Time$ | Test Case | |:-----|:----:|:----:|:----:|:-----| | ard_categorical.survey.design | 💔 | $0.46$ | $+15.46$ | ard_categorical.survey.design_works | | ard_categorical.survey.design | 👶 | | $+0.02$ | ard_categorical.survey.design_works_when_using_generic_names_ | | ard_continuous.survey.design | 👶 | | $+0.01$ | ard_continuous.survey.design_works_when_using_generic_names_ | | ard_continuous.survey.design | 💔 | $1.86$ | $+19.04$ | unstratified_ard_continuous.survey.design_works | | ard_regression | 💔 | $0.05$ | $+1.28$ | ard_regression_works | | ard_stats_anova | 💔 | $0.02$ | $+1.32$ | ard_stats_anova.anova_works | | ard_survival_survfit | 💔 | $0.11$ | $+1.02$ | ard_survival_survfit_works_with_times_provided |

Results for commit bc72cc83ca3cc2fcfa923db2faffe87b503b1ac7

♻️ This comment has been updated with latest results.

github-actions[bot] commented 2 months ago

Code Coverage Summary

Filename                                Stmts    Miss  Cover    Missing
------------------------------------  -------  ------  -------  ---------------------------------------------------------------------------
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         387      13  96.64%   76, 102, 129-132, 222-225, 269, 511, 525
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                         51       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                  107      41  61.68%   101-104, 107-111, 143-146, 149-153, 164-173, 196, 208-212, 238-242, 249-253
R/proportion_ci.R                         195      28  85.64%   290, 293, 302-307, 315, 330, 438-461
TOTAL                                    3266     155  95.25%

Diff against main

Filename                             Stmts    Miss  Cover
---------------------------------  -------  ------  -------
R/ard_categorical.survey.design.R       +5      +4  -1.00%
R/construction_helpers.R                +2      +2  -1.17%
TOTAL                                   +7      +6  -0.17%

Results for commit: 0dde406a54eb0be89e30f1035c677319bd60bb16

Minimum allowed coverage is 80%

:recycle: This comment has been updated with latest results

insightsengineering / cardx