164 Add the list of all possible methods (blocks) for ReportCard

[kartikeyakirar]

fixes https://github.com/insightsengineering/teal.reporter/issues/164

for reviewer

• [ ] Confirm that the title/filename accurately reflects the content and scope.
• [ ] Verify that all available content blocks in teal.reporter are listed in the table.
• [ ] Any suggestion on changes in table . (colnames title if needs changes.)
• [ ] Read through the vignette for flow and coherence;
• [ ] Diagram shows accurate description.

[github-actions[bot]]

CLA Assistant Lite bot ✅ All contributors have signed the CLA

[kartikeyakirar]

I have read the CLA Document and I hereby sign the CLA

[github-actions[bot]]

Unit Tests Summary

  1 files   18 suites   10s :stopwatch: 192 tests 192 :white_check_mark: 0 :zzz: 0 :x: 332 runs  332 :white_check_mark: 0 :zzz: 0 :x:

Results for commit 910a24b9.

[github-actions[bot]]

Unit Tests Summary

  1 files   18 suites   36s :stopwatch: 189 tests 189 :white_check_mark: 0 :zzz: 0 :x: 329 runs  329 :white_check_mark: 0 :zzz: 0 :x:

Results for commit 26b13dec.

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

[github-actions[bot]]

Code Coverage Summary

Filename                  Stmts    Miss  Cover    Missing
----------------------  -------  ------  -------  -----------------------------------------------------------------------------------------------------
R/AddCardModule.R           146       2  98.63%   170, 207
R/ContentBlock.R             18       2  88.89%   57-63
R/DownloadModule.R          238      67  71.85%   98-104, 152, 183-188, 197-202, 205-210, 219-224, 227-232, 240-245, 248-253, 260-265, 268-273, 312-316
R/FileBlock.R                13       0  100.00%
R/LoadReporterModule.R      103      19  81.55%   100-105, 108-113, 119-124, 136
R/NewpageBlock.R              2       0  100.00%
R/PictureBlock.R             30       2  93.33%   20, 118
R/Previewer.R               372      95  74.46%   96-98, 101-102, 184-213, 217-219, 222, 289, 304, 306-309, 312, 315-323, 437-481
R/RcodeBlock.R               15       0  100.00%
R/Renderer.R                113      37  67.26%   97-112, 216, 224, 233, 235-256
R/ReportCard.R               84       3  96.43%   239, 244, 269
R/Reporter.R                107       6  94.39%   273-278
R/ResetModule.R              53       0  100.00%
R/SimpleReporter.R           32       0  100.00%
R/TableBlock.R                9       0  100.00%
R/TextBlock.R                13       0  100.00%
R/utils.R                   126      86  31.75%   7, 38-97, 99, 102-109, 137, 161-169, 206-215
R/yaml_utils.R               81       2  97.53%   78, 289
R/zzz.R                      14      10  28.57%   2-13, 19
TOTAL                      1569     331  78.90%

Diff against main

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

Results for commit: 26b13decbaf14d78939355353a8ae49e816866ca

Minimum allowed coverage is 80%

: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$
Renderer	💚	$3.37$	$-2.45$	$0$	$0$	$0$	$0$
ReportCard	💚	$5.04$	$-3.86$	$0$	$0$	$0$	$0$
Reporter	💚	$3.60$	$-1.95$	$0$	$0$	$0$	$0$
TableBlock	💚	$14.37$	$-12.93$	$0$	$0$	$0$	$0$
utils	💚	$4.58$	$-4.03$	$+3$	$0$	$0$	$0$

Additional test case details

| Test Suite | $Status$ | Time on `main` | $±Time$ | Test Case | |:-----|:----:|:----:|:----:|:-----| | Renderer | 💚 | $2.90$ | $-2.47$ | renderRmd_asserts_the_argument_is_a_list_of_TextBlocks_PictureBlock_NewpageBlock_TableBlock | | ReportCard | 💚 | $2.38$ | $-2.17$ | append_table_accepts_a_data.frame | | ReportCard | 💚 | $2.20$ | $-1.96$ | append_table_returns_self | | Reporter | 💚 | $3.36$ | $-2.05$ | default_reporter_id | | TableBlock | 💚 | $2.41$ | $-2.16$ | from_list_after_to_list_to_save_and_retrive | | TableBlock | 💚 | $2.27$ | $-2.08$ | set_content_accepts_a_table_object | | TableBlock | 💚 | $2.36$ | $-2.17$ | set_content_returns_the_TableBlock_object | | TableBlock | 💚 | $2.39$ | $-2.19$ | set_content_supports_data.frame_object | | TableBlock | 💚 | $2.38$ | $-2.20$ | to_list_returns_a_named_list_with_a_one_field_a_proper_file_name | | TableBlock | 💚 | $2.38$ | $-2.19$ | to_list_returns_a_named_list_with_a_one_field_a_proper_path | | utils | 👶 | | $+0.17$ | custom_theme_to_flextable | | utils | 👶 | | $+0.00$ | get_merge_index | | utils | 👶 | | $+0.00$ | get_merge_index_single | | utils | 👶 | | $+0.16$ | merge_at_indice | | utils | 👶 | | $+0.16$ | padding_lst_applies_padding_to_a_flextable_based_on_indentation_levels | | utils | 👶 | | $+0.03$ | to_flextable_supported_class | | utils | 💀 | $0.12$ | $-0.12$ | to_flextable_supported_class_data.frame_ | | utils | 💀 | $4.33$ | $-4.33$ | to_flextable_supported_class_listing_df_ | | utils | 💀 | $0.10$ | $-0.10$ | to_flextable_supported_class_rtables_ |

Results for commit c0b74ec214951e6e60eb10858dbd249de35b8ff7

♻️ This comment has been updated with latest results.

[pawelru]

This is a very good resource for a learning. It would be great to link it somewhere in the roxygen docs of the described classes. I'm just concerned that this would not be ever looked into without such refs.

[kartikeyakirar]

It would be great to link it somewhere in the roxygen docs of the described classes. I'm just concerned that this would not be ever looked into without such refs.

I agree and have linked this to ReportCard since all the blocks are utilized within it. This seems like the most appropriate place, especially considering it's an exported class. here 26b13de