50-add-input-data-requirements-trade-off-plot

[chen-chen-stat]

…LIST.

[github-actions[bot]]

Code Coverage Summary

Filename                           Stmts    Miss  Cover    Missing
-------------------------------  -------  ------  -------  ----------------------------------------------------------------------------------------------------------------------------------------
R/check_feature.R                    345     300  13.04%   12-331, 360-364, 368-371, 386-390, 405-409, 427-431, 444-449
R/ci_calculation.R                    92       0  100.00%
R/correlogram.R                      135       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/forest_dot_plot_utils.R           1493    1359  8.98%    16-1502, 1565-1567, 1584-1589, 1615-1618, 1639, 1704-1727, 1783-1800, 1814, 1817, 1885-2220
R/forest_dot_plot.R                  104     104  0.00%    4-254
R/grouped_barchart.R                  12      12  0.00%    36-48
R/line_chart.R                       136      20  85.29%   93-98, 119-120, 186-192, 209-213
R/order_label_der.R                   55      55  0.00%    35-97
R/pyramid_chart.R                     76       1  98.68%   52
R/scatterplot_function.R             121      13  89.26%   40-42, 70-81
R/stacked_barchart.R                  39       0  100.00%
R/tradeoff_plot.R                    890     424  52.36%   148-196, 290, 297-298, 302-303, 345-346, 355-365, 437-443, 452-456, 559-570, 757-786, 825-864, 890-1028, 1036-1090, 1126-1133, 1167-1277
R/utils.R                            289      37  87.20%   443-496, 523-529, 557-669
R/value_tree.R                         1       1  0.00%    45
TOTAL                               4135    2366  42.78%

Diff against main

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

Results for commit: 866c64ef31731a8bb78d53d62fd3534797a02171

Minimum allowed coverage is 80%

:recycle: This comment has been updated with latest results

[github-actions[bot]]

Unit Tests Summary

  1 files    9 suites   13s :stopwatch:  60 tests  60 :white_check_mark: 0 :zzz: 0 :x: 410 runs  410 :white_check_mark: 0 :zzz: 0 :x:

Results for commit 866c64ef.

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

[chen-chen-stat]

@Lovemore-Gakava @aemabe Added a note in the documentation for the requirements of input data: "Note that the variables Grouped_Outcome, Statistics, and Outcome_Status are not required for generating a trade-off plot, but are listed as required columns because they are key for generating a value tree, which is a starting point for all subsequent benefit-risk assessments."

[github-actions[bot]]

Github pages

Review the pkgdown webpage for the PR here

[aemabe]

Hi Chen, I like the wording you chose to clarify the optional variables. It is very clear to me the purpose of keeping these variables required, even if they are not required for the specific function.