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

add unit tests for protected names #266

Merged
merged 13 commits into from
Jul 19, 2024
Merged

add unit tests for protected names #266

merged 13 commits into from
Jul 19, 2024

Conversation

ayogasekaram
Copy link
Contributor

@ayogasekaram ayogasekaram commented Jul 11, 2024

What changes are proposed in this pull request?

  • Added unit tests for protected names for ard_continuous and ard_categorical

closes #265


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.
  • Code coverage is suitable for any new functions/features (generally, 100% coverage for new code): devtools::test_coverage()
  • Request a reviewer

Reviewer Checklist (if item does not apply, mark is as complete)

  • If a bug was fixed, a unit test was added.
  • Run pkgdown::build_site(). Check the R console for errors, and review the rendered website.
  • 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 "# cards (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".

Copy link
Contributor

github-actions bot commented Jul 11, 2024

✅ All contributors have signed the CLA
Posted by the CLA Assistant Lite bot.

@ayogasekaram
Copy link
Contributor Author

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

Copy link
Contributor

github-actions bot commented Jul 11, 2024

Unit Tests Summary

  1 files   93 suites   28s ⏱️
 90 tests  57 ✅ 33 💤 0 ❌
213 runs  164 ✅ 49 💤 0 ❌

Results for commit 8811208.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Jul 11, 2024

Unit Test Performance Difference

Additional test case details
Test Suite $Status$ Time on main $±Time$ Test Case
ard_categorical 💔 $0.81$ $+7.98$ ard_categorical_univariate
ard_categorical 👶 $+0.02$ ard_categorical_works_when_using_generic_names_
ard_continuous 💚 $2.54$ $-2.44$ ard_continuous_works
ard_continuous 👶 $+0.02$ ard_continuous_works_when_using_generic_names_
ard_hierarchical 💔 $0.11$ $+7.68$ ard_hierarchical_works_without_by_variables

Results for commit 27552eb

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Jul 11, 2024

badge

Code Coverage Summary

Filename                       Stmts    Miss  Cover    Missing
---------------------------  -------  ------  -------  --------------------------
R/apply_fmt_fn.R                  95      24  74.74%   36-43, 109-116, 198-205
R/ard_attributes.R                35       1  97.14%   56
R/ard_categorical.R              342      16  95.32%   233, 393-394, 550-565, 599
R/ard_complex.R                   34       0  100.00%
R/ard_continuous.R               176       4  97.73%   118, 200-201, 299
R/ard_dichotomous.R               80       8  90.00%   62, 150-155, 178
R/ard_hierarchical.R              83       0  100.00%
R/ard_missing.R                   56       0  100.00%
R/ard_stack.R                     84       7  91.67%   107, 186-191
R/ard_total_n.R                    7       0  100.00%
R/as_nested_list.R                41       0  100.00%
R/bind_ard.R                      22       3  86.36%   51-53
R/check_ard_structure.R           39       6  84.62%   31, 55-59
R/default_stat_labels.R           18       0  100.00%
R/eval_capture_conditions.R       18       0  100.00%
R/get_ard_statistics.R            16       1  93.75%   75
R/nest_for_ard.R                  71       1  98.59%   60
R/print_ard_conditions.R          75      66  12.00%   60-176
R/print.R                         72       0  100.00%
R/process_selectors.R            126       1  99.21%   337
R/replace_null_statistic.R        11       0  100.00%
R/round5.R                         1       0  100.00%
R/selectors.R                     14       0  100.00%
R/shift_ard_columns.R             77      13  83.12%   61, 69, 144-147, 150-156
R/shuffle_ard.R                  102       0  100.00%
R/summary_functions.R             25       1  96.00%   59
R/tidy_ard_order.R                25       0  100.00%
R/tidy_as_ard.R                   39      11  71.79%   88-98
R/utils.R                         24       0  100.00%
TOTAL                           1808     163  90.98%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: 8811208

Minimum allowed coverage is 80%

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

I think just one small change and we are good to go, thank you!!

@@ -178,3 +178,11 @@
Error in `ard_categorical()`:
! The `by` argument cannot include variables named "variable" and "variable_level".

# ard_categorical.survey.design(by) messages about protected names
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you update the title/test chunk name to not reference the survey methods?

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.

Thank you @ayogasekaram !!

@ddsjoberg ddsjoberg merged commit 0586777 into main Jul 19, 2024
35 checks passed
@ddsjoberg ddsjoberg deleted the 265_protected_names@main branch July 19, 2024 11:09
@github-actions github-actions bot locked and limited conversation to collaborators Jul 19, 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.

add unit tests to assess protected names (ard_categorical and ard_continuous)
2 participants