Skip to content

Fmt fn to fmt fun #302

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

Merged
merged 7 commits into from
Jun 25, 2025
Merged

Fmt fn to fmt fun #302

merged 7 commits into from
Jun 25, 2025

Conversation

ddsjoberg
Copy link
Collaborator

What changes are proposed in this pull request?

  • Updating any fmt_fn references to fmt_fun for consistency.
    • Any function with an argument cardx::foo(fmt_fn) has been updated to cardx::foo(fmt_fun). The old syntax will continue to function, but with a deprecation warning to users.
    • Importantly, the ARD column named "fmt_fn" has been updated to "fmt_fun". This change cannot be formally deprecated. For users who were accessing the ARD object directly to modify this column instead of using functions like cards::update_ard_fmt_fun(), this will be a breaking change.

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.
  • 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") 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""))
  • 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 ✅
  • Approve Pull Request
  • Merge the PR. Please use "Squash and merge" or "Rebase and merge".

Copy link
Contributor

github-actions bot commented Jun 23, 2025

Unit Tests Summary

  1 files  183 suites   1m 15s ⏱️
181 tests 181 ✅ 0 💤 0 ❌
754 runs  754 ✅ 0 💤 0 ❌

Results for commit caba711.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Jun 23, 2025

Unit Test Performance Difference

Additional test case details
Test Suite $Status$ Time on main $±Time$ Test Case
ard_continuous.survey.design 💀 $0.00$ $-0.00$ ard_continuous.survey.design_fmt_fn_
ard_continuous.survey.design 👶 $+0.00$ ard_continuous.survey.design_fmt_fun_

Results for commit c1fff9a

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Jun 23, 2025

badge

Code Coverage Summary

Filename                                Stmts    Miss  Cover    Missing
------------------------------------  -------  ------  -------  ------------------------------------------
R/add_total_n.survey.design.R              10       0  100.00%
R/ard_aod_wald_test.R                      77       2  97.40%   93, 96
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                            62       1  98.39%   87
R/ard_categorical_ci.R                    320       1  99.69%   93
R/ard_categorical_ci.survey.design.R      129       1  99.22%   180
R/ard_categorical_max.R                    51       7  86.27%   54-59, 74
R/ard_categorical.survey.design.R         400      14  96.50%   69-74, 89, 240-243, 287, 529, 543
R/ard_continuous_ci.R                      28       1  96.43%   38
R/ard_continuous_ci.survey.design.R       138       0  100.00%
R/ard_continuous.survey.design.R          284      20  92.96%   59-64, 98, 189, 199, 350, 381-382, 433-441
R/ard_dichotomous.survey.design.R          80       9  88.75%   40-45, 62, 167, 172
R/ard_effectsize_cohens_d.R               103       2  98.06%   69, 122
R/ard_effectsize_hedges_g.R                91       2  97.80%   68, 120
R/ard_emmeans_mean_difference.R            88       0  100.00%
R/ard_incidence_rate.R                    104       0  100.00%
R/ard_missing.survey.design.R              89       7  92.13%   45-50, 63
R/ard_regression_basic.R                   31       1  96.77%   61
R/ard_regression.R                         87       0  100.00%
R/ard_smd_smd.R                            69       5  92.75%   57, 83-86
R/ard_stats_anova.R                        95       0  100.00%
R/ard_stats_aov.R                          46       0  100.00%
R/ard_stats_chisq_test.R                   40       1  97.50%   39
R/ard_stats_fisher_test.R                  43       1  97.67%   42
R/ard_stats_kruskal_test.R                 36       1  97.22%   38
R/ard_stats_mantelhaen_test.R              67       1  98.51%   45
R/ard_stats_mcnemar_test.R                 80       2  97.50%   63, 106
R/ard_stats_mood_test.R                    49       1  97.96%   45
R/ard_stats_oneway_test.R                  39       0  100.00%
R/ard_stats_poisson_test.R                 76       1  98.68%   59
R/ard_stats_prop_test.R                    85       1  98.82%   43
R/ard_stats_t_test_onesample.R             41       0  100.00%
R/ard_stats_t_test.R                      112       2  98.21%   65, 111
R/ard_stats_wilcox_test_onesample.R        42       0  100.00%
R/ard_stats_wilcox_test.R                  99       2  97.98%   65, 117
R/ard_survey_svychisq.R                    38       1  97.37%   44
R/ard_survey_svyranktest.R                 54       1  98.15%   44
R/ard_survey_svyttest.R                    53       1  98.11%   42
R/ard_survival_survdiff.R                  89       0  100.00%
R/ard_survival_survfit_diff.R              76       0  100.00%
R/ard_survival_survfit.R                  236       5  97.88%   234-238
R/construction_helpers.R                  106      10  90.57%   160-175, 189, 248
R/proportion_ci.R                         203       1  99.51%   463
TOTAL                                    4093     107  97.39%

Diff against main

Filename                             Stmts    Miss  Cover
---------------------------------  -------  ------  -------
R/ard_categorical_max.R                 +7      +6  -11.45%
R/ard_categorical.survey.design.R       +7      +6  -1.46%
R/ard_continuous.survey.design.R        +7      +6  -1.99%
R/ard_dichotomous.survey.design.R       +7      +6  -7.14%
R/ard_missing.survey.design.R           +7      +6  -6.65%
TOTAL                                  +35     +30  -0.72%

Results for commit: caba711

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

@ddsjoberg ddsjoberg merged commit 5212bf9 into main Jun 25, 2025
33 checks passed
@ddsjoberg ddsjoberg deleted the fmt_fn-to-fmt_fun branch June 25, 2025 18:30
@github-actions github-actions bot locked and limited conversation to collaborators Jun 25, 2025
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.

1 participant