Skip to content
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

Enhance formula processing in ard_survival_survfit() #226

Merged
merged 8 commits into from
Oct 25, 2024

Conversation

edelarua
Copy link
Contributor

@edelarua edelarua commented Oct 23, 2024

What changes are proposed in this pull request?

  • Implemented summary(extend=TRUE) in ard_survival_survfit() to return results for time points out of bounds.
  • Added a data.frame method to ard_survival_survfit().
  • Added a warning for incorrect formula type to ard_survival_survfit().

Closes #223 and #224


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

@edelarua edelarua added the sme label Oct 23, 2024
Copy link
Contributor

github-actions bot commented Oct 23, 2024

Unit Tests Summary

  1 files  143 suites   1m 5s ⏱️
142 tests 109 ✅ 33 💤 0 ❌
541 runs  496 ✅ 45 💤 0 ❌

Results for commit df57767.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Oct 23, 2024

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
ard_attributes.survey.design 💚 $1.66$ $-1.64$ $0$ $+1$ $0$ $0$
Additional test case details
Test Suite $Status$ Time on main $±Time$ Test Case
ard_aod_wald_test 💔 $0.16$ $+1.42$ ard_aod_wald_test_works
ard_attributes.survey.design 💚 $1.66$ $-1.64$ ard_attributes.survey.design_works
ard_categorical.survey.design 💚 $16.78$ $-1.26$ ard_categorical.survey.design_works
ard_continuous.survey.design 💔 $13.31$ $+7.11$ unstratified_ard_continuous.survey.design_works
ard_survival_survfit 👶 $+0.01$ ard_survival_survfit.data.frame_works_as_expected
ard_survival_survfit 👶 $+0.00$ ard_survival_survfit_extends_to_times_outside_range
construction_helpers 💚 $2.27$ $-1.85$ construct_model_works
proportion_ci 💚 $1.76$ $-1.62$ check_the_proportion_ci__functions_work

Results for commit b60433c

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Oct 23, 2024

badge

Code Coverage Summary

Filename                                Stmts    Miss  Cover    Missing
------------------------------------  -------  ------  -------  --------------------------
R/add_total_n.survey.design.R              12       0  100.00%
R/ard_aod_wald_test.R                      77       8  89.61%   38-43, 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                     96       1  98.96%   83
R/ard_categorical_ci.survey.design.R      128       3  97.66%   152-153, 179
R/ard_categorical.survey.design.R         391       8  97.95%   77, 226-229, 273, 515, 529
R/ard_continuous_ci.R                      28       1  96.43%   38
R/ard_continuous_ci.survey.design.R       137       0  100.00%
R/ard_continuous.survey.design.R          201       3  98.51%   86, 177, 187
R/ard_dichotomous.survey.design.R          73       3  95.89%   51, 156, 161
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            70       0  100.00%
R/ard_missing.survey.design.R              79       1  98.73%   52
R/ard_regression_basic.R                   16       1  93.75%   46
R/ard_regression.R                         73       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_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                  196       5  97.45%   203-207
R/construction_helpers.R                  106      10  90.57%   160-175, 189, 248
R/proportion_ci.R                         195       1  99.49%   454
TOTAL                                    3443      72  97.91%

Diff against main

Filename                    Stmts    Miss  Cover
------------------------  -------  ------  -------
R/ard_survival_survfit.R      +22      -6  +3.77%
TOTAL                         +22      -6  +0.19%

Results for commit: df57767

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Collaborator

@ddsjoberg ddsjoberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for putting this together so quickly! Just a couple of comments

R/ard_survival_survfit.R Outdated Show resolved Hide resolved
R/ard_survival_survfit.R Outdated Show resolved Hide resolved
R/ard_survival_survfit.R Outdated Show resolved Hide resolved
R/ard_survival_survfit.R Outdated Show resolved Hide resolved
R/ard_survival_survfit.R Outdated Show resolved Hide resolved
tests/testthat/_snaps/ard_survival_survfit.md Show resolved Hide resolved
R/ard_survival_survfit.R Outdated Show resolved Hide resolved
@edelarua edelarua linked an issue Oct 25, 2024 that may be closed by this pull request
@ddsjoberg ddsjoberg merged commit 0554942 into main Oct 25, 2024
33 checks passed
@ddsjoberg ddsjoberg deleted the 223_update_ard_survfit@main branch October 25, 2024 22:08
@ddsjoberg
Copy link
Collaborator

This is great! Thank you @edelarua !

@github-actions github-actions bot locked and limited conversation to collaborators Oct 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
2 participants