update_ard_fmt_fn needs some love

[kimjj93]

Fixes #449

Added vignette for update_ard_fmt_fun and update_ard_stat_label under Articles

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 ✅
• 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".

Optional Reverse Dependency Checks:

Install checked with pak::pak("Genentech/checked") or pak::pak("checked")

# Check dev versions of `cardx`, `gtsummary`, and `tfrmt` which are in the `ddsjoberg` R Universe
Rscript -e "options(checked.check_envvars = c(NOT_CRAN = TRUE)); checked::check_rev_deps(path = '.', n = parallel::detectCores() - 2L, repos = c('https://ddsjoberg.r-universe.dev', 'https://cloud.r-project.org'))"

# Check CRAN reverse dependencies but run tests skipped on CRAN
Rscript -e "options(checked.check_envvars = c(NOT_CRAN = TRUE)); checked::check_rev_deps(path = '.', n = parallel::detectCores() - 2, repos = 'https://cloud.r-project.org')"

# Check CRAN reverse dependencies in a CRAN-like environment
Rscript -e "options(checked.check_envvars = c(NOT_CRAN = FALSE), checked.check_build_args = '--as-cran'); checked::check_rev_deps(path = '.', n = parallel::detectCores() - 2, repos = 'https://cloud.r-project.org')"

[github-actions]

Unit Tests Summary

  1 files  203 suites   1m 5s ⏱️
203 tests 118 ✅  85 💤 0 ❌
454 runs  338 ✅ 116 💤 0 ❌

Results for commit e71e29b.

♻️ This comment has been updated with latest results.

[github-actions]

Unit Test Performance Difference

Additional test case details

Test Suite	$Status$	Time on main	$±Time$	Test Case
ard_summary	💔	$0.43$	$+1.60$	ard_summary_works

Results for commit 53fa2bc

♻️ This comment has been updated with latest results.

[ddsjoberg]

this is great, thank you @kimjj93 !!

I love that it begins with letting users know this is just a data frame, and any value in the ARD data frame can be updated using dplyr or base R functions. In this introduction section, can we also explain list columns (which will be new to many users), and while the list columns can be updated just like any other column in a data frame, it can be a bit trickier. because it can be somewhat less clear how to work with list columns, we have helpers, and then we go into the sections explaining the helpers?

[github-actions]

Code Coverage Summary

Filename                       Stmts    Miss  Cover    Missing
---------------------------  -------  ------  -------  ----------------------------------------
R/add_calculated_row.R            53       6  88.68%   51-56
R/apply_fmt_fun.R                116       0  100.00%
R/ard_attributes.R                46       1  97.83%   57
R/ard_formals.R                   13       0  100.00%
R/ard_hierarchical.R              94      12  87.23%   88-93, 179-184
R/ard_identity.R                  13       0  100.00%
R/ard_missing.R                   65       7  89.23%   45-50, 61
R/ard_mvsummary.R                 43       7  83.72%   76-81, 94
R/ard_pairwise.R                  46       0  100.00%
R/ard_stack_hierarchical.R       274       0  100.00%
R/ard_stack.R                     97       0  100.00%
R/ard_strata.R                    33       0  100.00%
R/ard_summary.R                  194       8  95.88%   87-92, 218-219
R/ard_tabulate_rows.R             12       0  100.00%
R/ard_tabulate_value.R            72       7  90.28%   51-56, 73
R/ard_tabulate.R                 409      16  96.09%   108-113, 255, 467-471, 478-479, 656, 689
R/ard_total_n.R                   14       0  100.00%
R/as_card_fn.R                     8       0  100.00%
R/as_card.R                        5       0  100.00%
R/as_nested_list.R                41       0  100.00%
R/bind_ard.R                      47      11  76.60%   74-85
R/cards-package.R                  1       1  0.00%    14
R/check_ard_structure.R           39       6  84.62%   31, 55-59
R/default_stat_labels.R           20       0  100.00%
R/deprecated.R                    34      30  11.76%   38-39, 54-71, 86-132
R/eval_capture_conditions.R       30       0  100.00%
R/filter_ard_hierarchical.R      208       0  100.00%
R/get_ard_statistics.R            16       0  100.00%
R/maximum_variable_value.R        15       0  100.00%
R/mock.R                         137       2  98.54%   116, 245
R/nest_for_ard.R                  74       1  98.65%   64
R/print_ard_conditions.R          83       0  100.00%
R/print.R                         80       0  100.00%
R/process_selectors.R            126       1  99.21%   337
R/rename_ard_columns.R            73       0  100.00%
R/rename_ard_groups.R             60       0  100.00%
R/replace_null_statistic.R        11       0  100.00%
R/round5.R                         1       0  100.00%
R/selectors.R                     23       0  100.00%
R/shuffle_ard.R                  167       0  100.00%
R/sort_ard_hierarchical.R        163       0  100.00%
R/summary_functions.R             25       1  96.00%   59
R/tidy_ard_order.R                34       0  100.00%
R/tidy_as_ard.R                   40       0  100.00%
R/unlist_ard_columns.R            27       0  100.00%
R/update_ard.R                    60       6  90.00%   54-59
R/utils.R                         24       0  100.00%
TOTAL                           3266     123  96.23%

Diff against main

Filename                 Stmts    Miss  Cover
---------------------  -------  ------  --------
R/ard_stack.R               -2       0  +100.00%
R/ard_tabulate_rows.R      +12       0  +100.00%
R/ard_tabulate.R            +9       0  +0.09%
R/deprecated.R              -6      -6  +1.76%
R/nest_for_ard.R            +3       0  +0.06%
R/shuffle_ard.R             +6       0  +100.00%
TOTAL                      +22      -6  +0.21%

Results for commit: e71e29b

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results