13 create cumulative excess number plot

[aemabe]

Created a new file that hosts all three functions included in the cumulative excess plot, along with corresponding manuscript data. Updated the README with the cumulative excess plot from manuscript. Tests have been created, and functions modified, to have the ability to account for missing data and/or variables. Should be a dynamic function.

[github-actions[bot]]

Code Coverage Summary

Filename                           Stmts    Miss  Cover    Missing
-------------------------------  -------  ------  -------  -------------------------------------------------------------------------------------------------------------------------------------
R/check_feature.R                    345     300  13.04%   12-330, 359-363, 367-370, 385-389, 404-408, 426-430, 443-448
R/ci_calculation.R                    92       0  100.00%
R/cumulative_excess_functions.R      347      40  88.47%   94-95, 105-106, 192-199, 236-247, 304-308, 443-451, 469-471
R/grouped_barchart.R                  12      12  0.00%    23-35
R/pyramid_chart.R                     76       1  98.68%   52
R/tradeoff_plot.R                    890     424  52.36%   92-140, 234, 241-242, 246-247, 289-290, 299-309, 381-387, 396-400, 503-514, 701-730, 769-808, 834-972, 980-1034, 1070-1077, 1111-1221
R/utils.R                            285      51  82.11%   443-611
TOTAL                               2047     828  59.55%

Diff against main

Filename                           Stmts    Miss  Cover
-------------------------------  -------  ------  -------
R/cumulative_excess_functions.R     +347     +40  +88.47%
TOTAL                               +347     +40  +5.90%

Results for commit: 022f73aa383951f9cb5aadb93bca025f68412400

Minimum allowed coverage is 80%

:recycle: This comment has been updated with latest results

[github-actions[bot]]

Unit Tests Summary

  1 files    4 suites   8s :stopwatch:  32 tests  32 :white_check_mark: 0 :zzz: 0 :x: 292 runs  292 :white_check_mark: 0 :zzz: 0 :x:

Results for commit 022f73aa.

:recycle: This comment has been updated with latest results.

[github-actions[bot]]

Unit Test Performance Difference

Test Suite	$Status$	Time on main	$±Time$	$±Tests$	$±Skipped$	$±Failures$	$±Errors$
cumulative_excess_plot	👶		$+3.70$	$+124$	$0$	$0$	$0$

Additional test case details

| Test Suite | $Status$ | Time on `main` | $±Time$ | Test Case | |:-----|:----:|:----:|:----:|:-----| | cumulative_excess_plot | 👶 | | $+0.01$ | gensurv_combined_expects_an_error_when_df_table_and_df_plot_are_missing_required_variables | | cumulative_excess_plot | 👶 | | $+0.73$ | gensurv_combined_will_output_a_visible_object | | cumulative_excess_plot | 👶 | | $+0.78$ | gensurv_combined_will_return_a_custom_warning_concerning_missing_data | | cumulative_excess_plot | 👶 | | $+0.68$ | gensurv_combined_will_return_a_visible_object_with_missing_data | | cumulative_excess_plot | 👶 | | $+0.01$ | gensurv_plot_expects_an_error_when_df_outcome_has_misnamed_variables | | cumulative_excess_plot | 👶 | | $+0.01$ | gensurv_plot_expects_an_error_when_df_outcome_is_missing_required_variables | | cumulative_excess_plot | 👶 | | $+0.21$ | gensurv_plot_will_ouput_a_visible_object | | cumulative_excess_plot | 👶 | | $+0.21$ | gensurv_plot_will_return_a_custom_warning_concerning_missing_data | | cumulative_excess_plot | 👶 | | $+0.21$ | gensurv_plot_will_return_a_visible_object_with_missing_data | | cumulative_excess_plot | 👶 | | $+0.01$ | gensurv_table_expects_an_error_when_df_table_and_df_plot_have_misnamed_variables | | cumulative_excess_plot | 👶 | | $+0.01$ | gensurv_table_expects_an_error_when_df_table_has_misnamed_variables | | cumulative_excess_plot | 👶 | | $+0.01$ | gensurv_table_expects_an_error_when_df_table_is_missing_required_variables | | cumulative_excess_plot | 👶 | | $+0.44$ | gensurv_table_will_ouput_a_ggplot_object | | cumulative_excess_plot | 👶 | | $+0.20$ | gensurv_table_will_return_a_custom_warning_message_concerning_missing_data | | cumulative_excess_plot | 👶 | | $+0.18$ | gensurv_table_will_return_a_visible_object_with_missing_data |

Results for commit 36375461ff03a95e445f96ebac02dcbf021f8935

♻️ This comment has been updated with latest results.

[chen-chen-stat]

@aemabe Thank you for creating the PR. I have a minor comment: In cumulative_excess_functions.R, "control" and "comparator" were used exchangeably. I think it would be good to use "control" consistently. Otherwise it looks good to me!

[github-actions[bot]]

Github pages

Review the pkgdown webpage for the PR here