Adding `ard_heirarchicial(id)` argument

ddsjoberg commented 2 months ago

What changes are proposed in this pull request?

Added the optional ard_heirarchicial(id) argument. When provided we check for duplicates across the column(s) supplied here. If duplicates are found, the user is warned that the percentages and denominators are not correct. (#214)

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

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.
[ ] 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 :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

Code Coverage Summary

Filename                       Stmts    Miss  Cover    Missing
---------------------------  -------  ------  -------  -------------------------------
R/apply_fmt_fn.R                  68       2  97.06%   96, 176
R/ard_attributes.R                29       0  100.00%
R/ard_categorical.R              347      17  95.10%   112, 212, 372-373, 529-544, 578
R/ard_complex.R                   33       0  100.00%
R/ard_continuous.R               175       4  97.71%   106, 188-189, 287
R/ard_dichotomous.R               66       2  96.97%   50, 136
R/ard_hierarchical.R              81       0  100.00%
R/ard_missing.R                   17       0  100.00%
R/ard_stack.R                     51       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           27       1  96.30%   26
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                  70       1  98.57%   56
R/print_ard_conditions.R          75      66  12.00%   61-177
R/print.R                         72       0  100.00%
R/process_selectors.R            114       0  100.00%
R/replace_null_statistic.R        11       0  100.00%
R/round5.R                         1       0  100.00%
R/selectors.R                     14       0  100.00%
R/shuffle_ard.R                  132       1  99.24%   267
R/summary_functions.R             58       1  98.28%   91
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                           1644     110  93.31%

Diff against main

Filename                Stmts    Miss  Cover
--------------------  -------  ------  --------
R/ard_hierarchical.R       +6       0  +100.00%
TOTAL                      +6       0  +0.02%

Results for commit: 8b979da4259075371814aab948365f3df0f7e935

Minimum allowed coverage is 80%

:recycle: This comment has been updated with latest results

github-actions[bot] commented 2 months ago

Unit Tests Summary

1 files 80 suites 12s :stopwatch: 78 tests 49 :white_check_mark: 29 :zzz: 0 :x: 164 runs 121 :white_check_mark: 43 :zzz: 0 :x:

Results for commit 8b979da4.

: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_hierarchical | 👶 | | $+0.01$ | ard_hierarchical_id_argument_works |

Results for commit 7f9f73daea7c2357a3c4a3c2037fed56f5db3b2f

♻️ This comment has been updated with latest results.

insightsengineering / cards