List options in `.stats` argument descriptions #1330

edelarua · 2024-10-17T23:05:40Z

Pull Request

Fixes #1329

github-actions · 2024-10-17T23:20:18Z

Unit Tests Summary

1 files 84 suites 1m 12s ⏱️
857 tests 846 ✅ 11 💤 0 ❌
1 841 runs 1 158 ✅ 683 💤 0 ❌

Results for commit 4ff9421.

♻️ This comment has been updated with latest results.

github-actions · 2024-10-17T23:20:21Z

Unit Test Performance Difference

Test Suite	$Status$	Time on `main`	$±Time$	$±Tests$	$±Skipped$	$±Failures$	$±Errors$
analyze_vars_in_cols	💔	$2.40$	$+3.44$	$+17$	$-7$	$0$	$0$
count_occurrences	💔	$0.75$	$+1.68$	$+10$	$-8$	$0$	$0$
summarize_coxreg	💔	$3.84$	$+3.11$	$+13$	$-13$	$0$	$0$
summarize_num_patients	💔	$1.08$	$+1.32$	$+18$	$-16$	$0$	$0$
utils_rtables	💔	$3.27$	$+1.27$	$+16$	$-19$	$0$	$0$

Additional test case details

Test Suite	$Status$	Time on `main`	$±Time$	Test Case
analyze_vars_in_cols	💔	$0.46$	$+1.54$	summarize_works_with_nested_analyze
summarize_coxreg	💔	$0.62$	$+1.38$	summarize_coxreg_adds_the_multivariate_Cox_regression_layer_to_rtables

Results for commit caec5be

♻️ This comment has been updated with latest results.

github-actions · 2024-10-17T23:22:30Z

Code Coverage Summary

Filename                                   Stmts    Miss  Cover    Missing
---------------------------------------  -------  ------  -------  ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
R/abnormal_by_baseline.R                      65       0  100.00%
R/abnormal_by_marked.R                        55       5  90.91%   93-97
R/abnormal_by_worst_grade_worsen.R           116       3  97.41%   263-265
R/abnormal_by_worst_grade.R                   60       0  100.00%
R/abnormal.R                                  43       0  100.00%
R/analyze_variables.R                        166       2  98.80%   494, 634
R/analyze_vars_in_cols.R                     176      13  92.61%   178, 221, 235-236, 244-252
R/bland_altman.R                              92       1  98.91%   46
R/combination_function.R                       9       0  100.00%
R/compare_variables.R                         84       2  97.62%   257, 316
R/control_incidence_rate.R                    10       0  100.00%
R/control_logistic.R                           7       0  100.00%
R/control_step.R                              23       1  95.65%   58
R/control_survival.R                          15       0  100.00%
R/count_cumulative.R                          50       1  98.00%   74
R/count_missed_doses.R                        34       0  100.00%
R/count_occurrences_by_grade.R               113       1  99.12%   167
R/count_occurrences.R                        115       1  99.13%   116
R/count_patients_events_in_cols.R             67       1  98.51%   60
R/count_patients_with_event.R                 47       0  100.00%
R/count_patients_with_flags.R                 58       0  100.00%
R/count_values.R                              27       0  100.00%
R/cox_regression_inter.R                     154       0  100.00%
R/cox_regression.R                           161       0  100.00%
R/coxph.R                                    167       7  95.81%   191-195, 238, 253, 261, 267-268
R/d_pkparam.R                                406       0  100.00%
R/decorate_grob.R                            113       0  100.00%
R/desctools_binom_diff.R                     621      64  89.69%   53, 88-89, 125-126, 129, 199, 223-232, 264, 266, 286, 290, 294, 298, 353, 356, 359, 362, 422, 430, 439, 444-447, 454, 457, 466, 469, 516-517, 519-520, 522-523, 525-526, 593, 604-616, 620, 663, 676, 680
R/df_explicit_na.R                            30       0  100.00%
R/estimate_multinomial_rsp.R                  50       1  98.00%   65
R/estimate_proportion.R                      205      11  94.63%   83-90, 94, 99, 320, 486
R/fit_rsp_step.R                              36       0  100.00%
R/fit_survival_step.R                         36       0  100.00%
R/formatting_functions.R                     183       2  98.91%   141, 276
R/g_forest.R                                 585      59  89.91%   241, 253-256, 261-262, 278, 288-291, 336-339, 346, 415, 502, 515, 519-520, 525-526, 539, 555, 602, 633, 708, 717, 723, 742, 797-817, 820, 831, 850, 905, 908, 1043-1048
R/g_ipp.R                                    133       0  100.00%
R/g_km.R                                     350      57  83.71%   286-289, 308-310, 364-367, 401, 429, 433-476, 483-487
R/g_lineplot.R                               243      22  90.95%   196, 370-377, 416-426, 518, 526
R/g_step.R                                    68       1  98.53%   109
R/g_waterfall.R                               47       0  100.00%
R/h_adsl_adlb_merge_using_worst_flag.R        73       0  100.00%
R/h_biomarkers_subgroups.R                    46       0  100.00%
R/h_cox_regression.R                         110       0  100.00%
R/h_incidence_rate.R                          45       0  100.00%
R/h_km.R                                     509      41  91.94%   137, 189-194, 287, 378, 380-381, 392-394, 413, 420-421, 423-425, 433-435, 460, 465-468, 651-654, 1108-1119
R/h_logistic_regression.R                    468       3  99.36%   203-204, 273
R/h_map_for_count_abnormal.R                  54       0  100.00%
R/h_pkparam_sort.R                            15       0  100.00%
R/h_response_biomarkers_subgroups.R           90      12  86.67%   50-55, 107-112
R/h_response_subgroups.R                     178      18  89.89%   257-270, 329-334
R/h_stack_by_baskets.R                        64       1  98.44%   89
R/h_step.R                                   180       0  100.00%
R/h_survival_biomarkers_subgroups.R           88       6  93.18%   111-116
R/h_survival_duration_subgroups.R            207      18  91.30%   259-271, 336-341
R/imputation_rule.R                           17       0  100.00%
R/incidence_rate.R                            86       7  91.86%   67-72, 152
R/logistic_regression.R                      102       0  100.00%
R/missing_data.R                              21       3  85.71%   32, 66, 76
R/odds_ratio.R                               117       0  100.00%
R/prop_diff_test.R                            91       0  100.00%
R/prop_diff.R                                265      15  94.34%   70-73, 105, 290-297, 440, 605
R/prune_occurrences.R                         57       0  100.00%
R/response_biomarkers_subgroups.R             69       6  91.30%   196-201
R/response_subgroups.R                       213       8  96.24%   100-105, 260-261
R/riskdiff.R                                  65       5  92.31%   102-105, 114
R/rtables_access.R                            38       0  100.00%
R/score_occurrences.R                         20       1  95.00%   124
R/split_cols_by_groups.R                      49       0  100.00%
R/stat.R                                      59       0  100.00%
R/summarize_ancova.R                         106       2  98.11%   183, 188
R/summarize_change.R                          30       0  100.00%
R/summarize_colvars.R                         10       0  100.00%
R/summarize_coxreg.R                         172       0  100.00%
R/summarize_glm_count.R                      209       3  98.56%   193-194, 490
R/summarize_num_patients.R                    93       4  95.70%   117-119, 266
R/summarize_patients_exposure_in_cols.R       96       1  98.96%   56
R/survival_biomarkers_subgroups.R             78       6  92.31%   117-122
R/survival_coxph_pairwise.R                   79      11  86.08%   51-52, 64-72
R/survival_duration_subgroups.R              211       6  97.16%   124-129
R/survival_time.R                             79       0  100.00%
R/survival_timepoint.R                       113       7  93.81%   125-131
R/utils_checkmate.R                           68       0  100.00%
R/utils_default_stats_formats_labels.R       124       0  100.00%
R/utils_factor.R                             109       2  98.17%   84, 302
R/utils_ggplot.R                             110       0  100.00%
R/utils_grid.R                               126       5  96.03%   164, 279-286
R/utils_rtables.R                            100       4  96.00%   39, 46, 403-404
R/utils_split_funs.R                          52       2  96.15%   82, 94
R/utils.R                                    141       7  95.04%   118, 121, 124, 128, 137-138, 332
TOTAL                                      10522     459  95.64%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: 4ff9421

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

shajoezhu

Thanks so much @edelarua ! really like the changes! I was wondering if you could do a test on scda.test. once nothing breaks, we can merge it

shajoezhu · 2024-10-19T08:43:29Z

merge this if insightsengineering/scda.test#156 is green

shajoezhu · 2024-10-20T16:20:13Z

https://github.com/insightsengineering/scda.test/actions/runs/11416119342/job/31766967284?pr=156#step:17:113 good to go

Melkiades · 2024-10-22T17:24:50Z

R/abnormal_by_marked.R

-#'   to see available statistics for this function.
+#' @param .stats (`character`)\cr statistics to select for the table.
+#'
+#'   Options are: ``r shQuote(get_stats("abnormal_by_marked"))``


maybe better than writing them all as we were thinking? wdyt @edelarua?

I think it's nicer to keep it all together using get_stats() to keep things simple, we could make get_stats() internal if you think there's no benefit for users.

I see! lets keep get_stats then ;)

Probably we need to list all options in that documentation though

edelarua added 3 commits September 5, 2024 19:59

List out .stats options

af048be

Merge branch 'main' into list_stat_options@main

477bcca

Add space

1b5add5

edelarua added the sme label Oct 17, 2024

edelarua and others added 3 commits October 17, 2024 19:07

Temp removal of failing test

d2fa9ac

[skip roxygen] [skip vbump] Roxygen Man Pages Auto Update

a0b6952

Empty commit

5dc2b98

Merge branch 'main' into 1329_list_stat_options@main

4ff9421

shajoezhu approved these changes Oct 19, 2024

View reviewed changes

shajoezhu merged commit bd6fa4b into main Oct 20, 2024
29 checks passed

shajoezhu deleted the 1329_list_stat_options@main branch October 20, 2024 16:20

github-actions bot locked and limited conversation to collaborators Oct 20, 2024

Melkiades reviewed Oct 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

List options in `.stats` argument descriptions #1330

List options in `.stats` argument descriptions #1330

edelarua commented Oct 17, 2024

github-actions bot commented Oct 17, 2024 •

edited

Loading

github-actions bot commented Oct 17, 2024 •

edited

Loading

github-actions bot commented Oct 17, 2024 •

edited

Loading

shajoezhu left a comment

shajoezhu commented Oct 19, 2024

shajoezhu commented Oct 20, 2024

Melkiades Oct 22, 2024

edelarua Oct 22, 2024

Melkiades Oct 23, 2024

Melkiades Oct 23, 2024

List options in .stats argument descriptions #1330

List options in .stats argument descriptions #1330

Conversation

edelarua commented Oct 17, 2024

Pull Request

github-actions bot commented Oct 17, 2024 • edited Loading

Unit Tests Summary

github-actions bot commented Oct 17, 2024 • edited Loading

Unit Test Performance Difference

github-actions bot commented Oct 17, 2024 • edited Loading

Code Coverage Summary

Diff against main

shajoezhu left a comment

Choose a reason for hiding this comment

shajoezhu commented Oct 19, 2024

shajoezhu commented Oct 20, 2024

Melkiades Oct 22, 2024

Choose a reason for hiding this comment

edelarua Oct 22, 2024

Choose a reason for hiding this comment

Melkiades Oct 23, 2024

Choose a reason for hiding this comment

Melkiades Oct 23, 2024

Choose a reason for hiding this comment

List options in `.stats` argument descriptions #1330

List options in `.stats` argument descriptions #1330

github-actions bot commented Oct 17, 2024 •

edited

Loading

github-actions bot commented Oct 17, 2024 •

edited

Loading

github-actions bot commented Oct 17, 2024 •

edited

Loading