8 create dot forest plot

[Lovemore-Gakava]

Create dot-forest plot - added supporting functions and test.

[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/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%    23-35
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%   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                            289      37  87.20%   443-496, 523-529, 557-669
R/value_tree.R                         1       1  0.00%    45
TOTAL                               3864    2346  39.29%

Diff against main

Filename                     Stmts    Miss  Cover
-------------------------  -------  ------  --------
R/forest_dot_plot_utils.R    +1493   +1359  +8.98%
R/forest_dot_plot.R           +104    +104  +100.00%
R/order_label_der.R            +55     +55  +100.00%
R/utils.R                        0     -18  +6.23%
TOTAL                        +1652   +1500  -22.47%

Results for commit: 72d4a39f53fbda9bebe4987793ef32c766144bf5

Minimum allowed coverage is 80%

:recycle: This comment has been updated with latest results

[github-actions[bot]]

Unit Tests Summary

  1 files    7 suites   9s :stopwatch:  42 tests  42 :white_check_mark: 0 :zzz: 0 :x: 351 runs  351 :white_check_mark: 0 :zzz: 0 :x:

Results for commit 72d4a39f.

: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$
forest_dot_plot_utils	👶		$+0.18$	$+9$	$0$	$0$	$0$

Additional test case details

| Test Suite | $Status$ | Time on `main` | $±Time$ | Test Case | |:-----|:----:|:----:|:----:|:-----| | forest_dot_plot_utils | 👶 | | $+0.10$ | generate_fig_lft_returns_a_ggplot_object | | forest_dot_plot_utils | 👶 | | $+0.08$ | generate_fig_rft_returns_a_ggplot_object |

Results for commit 938643ed9ba55b8bcf1424e53c021aaad501a9b8

♻️ This comment has been updated with latest results.

[github-actions[bot]]

Github pages

Review the pkgdown webpage for the PR here

[Lovemore-Gakava]

@aemabe thanks for the review comments. I have added example for the top middle bottom plots. The dot-forest plot functions are dependent on the structure and format of the effects_table. Users should ensure the dataframe being passed to the dot-forest plot has similar variables as the effects table.