adding ard_survival_survfit_diff() function

[ddsjoberg]

What changes are proposed in this pull request?

• Added the ard_survival_survfit_diff() function for calculating differences in survival estimates. (Need an ard_() for survival estimate differences #126, @)

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

---

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", reference_pkg = "cardx") 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"", reference_pkg = "cardx"))
• 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".

[github-actions]

Code Coverage Summary

Filename                               Stmts    Miss  Cover    Missing
-----------------------------------  -------  ------  -------  ------------------------------------
R/ard_aod_wald_test.R                     77       8  89.61%   36-41, 91, 94
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                           61       2  96.72%   52, 86
R/ard_continuous.survey.design.R         194       2  98.97%   172, 182
R/ard_effectsize_cohens_d.R              102       2  98.04%   68, 121
R/ard_effectsize_hedges_g.R               97       2  97.94%   68, 127
R/ard_emmeans_mean_difference.R           70       0  100.00%
R/ard_proportion_ci.R                     42       5  88.10%   68-72
R/ard_regression_basic.R                  16       1  93.75%   46
R/ard_regression.R                        51       0  100.00%
R/ard_smd_smd.R                           68       5  92.65%   58, 84-87
R/ard_stats_anova.R                       95       0  100.00%
R/ard_stats_aov.R                         36       0  100.00%
R/ard_stats_chisq_test.R                  39       1  97.44%   39
R/ard_stats_fisher_test.R                 42       1  97.62%   42
R/ard_stats_kruskal_test.R                35       1  97.14%   38
R/ard_stats_mcnemar_test.R                79       2  97.47%   63, 105
R/ard_stats_mood_test.R                   48       1  97.92%   46
R/ard_stats_oneway_test.R                 38       0  100.00%
R/ard_stats_prop_test.R                   84       1  98.81%   43
R/ard_stats_t_test_onesample.R            40       0  100.00%
R/ard_stats_t_test.R                     111       2  98.20%   65, 111
R/ard_stats_wilcox_test_onesample.R       41       0  100.00%
R/ard_stats_wilcox_test.R                 98       2  97.96%   65, 117
R/ard_survey_svychisq.R                   37       1  97.30%   44
R/ard_survey_svyranktest.R                51       0  100.00%
R/ard_survey_svyttest.R                   50       0  100.00%
R/ard_survival_survdiff.R                 89       0  100.00%
R/ard_survival_survfit_diff.R             76       8  89.47%   31-34, 43-46
R/ard_survival_survfit.R                 174      13  92.53%   79-81, 85, 95-97, 128-132, 237
R/construction_helpers.R                  60       6  90.00%   153, 165-169
R/proportion_ci.R                        194      28  85.57%   290, 293, 302-307, 315, 330, 431-454
TOTAL                                   2342      96  95.90%

Diff against main

Filename                         Stmts    Miss  Cover
-----------------------------  -------  ------  -------
R/ard_survival_survfit_diff.R      +76      +8  +89.47%
TOTAL                              +76      +8  -0.22%

Results for commit: fae6d19

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

  1 files   69 suites   10s ⏱️
 69 tests  47 ✅ 22 💤 0 ❌
197 runs  163 ✅ 34 💤 0 ❌

Results for commit fae6d19.

♻️ This comment has been updated with latest results.

[ddsjoberg]

FYI @Nolan-Steed I am going to re-write this after we make a few updates to ard_survival_survfit() (outlined here #139) Essentially I am going to turn this into a wrapper function that uses ard_survival_survfit() to prep all the statistics and card structure.

[github-actions]

CLA Assistant Lite bot ✅ All contributors have signed the CLA

[github-actions]

Unit Test Performance Difference

Test Suite	$Status$	Time on main	$±Time$	$±Tests$	$±Skipped$	$±Failures$	$±Errors$
ard_survival_survfit_diff	👶		$+0.00$	$+1$	$+1$	$0$	$0$

Additional test case details

Test Suite	$Status$	Time on main	$±Time$	Test Case
ard_survival_survfit_diff	👶		$+0.00$	ard_survival_survfit_diff_messaging
ard_survival_survfit_diff	👶		$+0.32$	ard_survival_survfit_diff_works

Results for commit 5fe9a43

♻️ This comment has been updated with latest results.

[edelarua]

This looks great Daniel! Just a few typos in the error messages that I noticed.

[edelarua]

Awesome! Good to go!!