223 updated api for statistic argumnet

ddsjoberg commented 3 weeks ago

What changes are proposed in this pull request?

The API for ard_continuous(statistic) and ard_missing(statistic) arguments has been updated. Previously, the RHS of these argument's passed lists would be either continuous_summary_fns() and missing_summary_fns(). Now these arguments accept simple character vectors of the statistic names. For example, ard_categorical(statistic = everything() ~ c("n", "p", "N")) and ard_missing(statistic = everything() ~ c("N_obs", "N_miss", "N_nonmiss", "p_miss", "p_nonmiss")). (#223)

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

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 3 weeks ago

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                33       0  100.00%
R/ard_categorical.R              337      16  95.25%   225, 385-386, 542-557, 591
R/ard_complex.R                   34       0  100.00%
R/ard_continuous.R               176       4  97.73%   118, 200-201, 299
R/ard_dichotomous.R               66       2  96.97%   60, 146
R/ard_hierarchical.R              83       0  100.00%
R/ard_missing.R                   56       0  100.00%
R/ard_stack.R                     70       1  98.57%   103
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            125       1  99.20%   334
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                           1765     150  91.50%

Diff against main

Filename                 Stmts    Miss  Cover
---------------------  -------  ------  --------
R/apply_fmt_fn.R            +1      +1  -0.80%
R/ard_categorical.R        -11       0  -0.15%
R/ard_missing.R            +35       0  +100.00%
R/summary_functions.R      -33       0  -2.28%
TOTAL                       -8      +1  -0.09%

Results for commit: 5211fb2ec13567d115cb673ea70703f55d939759

Minimum allowed coverage is 80%

:recycle: This comment has been updated with latest results

github-actions[bot] commented 3 weeks ago

Unit Tests Summary

1 files 87 suites 13s :stopwatch: 85 tests 54 :white_check_mark: 31 :zzz: 0 :x: 175 runs 129 :white_check_mark: 46 :zzz: 0 :x:

Results for commit 5211fb2e.

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

github-actions[bot] commented 3 weeks ago

Unit Test Performance Difference

Additional test case details

| Test Suite | $Status$ | Time on `main` | $±Time$ | Test Case | |:-----|:----:|:----:|:----:|:-----| | ard_categorical | 💀 | $0.00$ | $-0.00$ | ard_categorical_statistic_works_with_custom_fns |

Results for commit f4790188ac52f67843052a19d1d93585d818bc55

♻️ This comment has been updated with latest results.

insightsengineering / cards