`module_teal` documentation update

kartikeyakirar commented 1 month ago

Fixes https://github.com/insightsengineering/teal/issues/1225

github-actions[bot] commented 1 month ago

Code Coverage Summary

Filename                          Stmts    Miss  Cover    Missing
------------------------------  -------  ------  -------  --------------------------------------------------------------------------------------------------------------------------------------------------
R/dummy_functions.R                  36      25  30.56%   21-37, 40-47
R/get_rcode_utils.R                  31       1  96.77%   50
R/include_css_js.R                   22      17  22.73%   12-38, 76-82
R/init.R                             86      31  63.95%   108-115, 161-162, 164, 176-197, 228-229, 231
R/landing_popup_module.R             25      25  0.00%    61-87
R/module_bookmark_manager.R         158     125  20.89%   42-43, 57-59, 70-83, 93-143, 148-149, 189, 224-301
R/module_filter_manager.R            84      19  77.38%   38-42, 157, 162-175
R/module_nested_tabs.R              168      67  60.12%   40-122, 138, 190, 212, 234, 242, 246
R/module_snapshot_manager.R         241     178  26.14%   95-107, 136-139, 143-144, 159-169, 173-188, 190-198, 205-220, 224-228, 230-236, 239-252, 255-273, 282-298, 313-336, 339-350, 353-359, 373, 394-418
R/module_tabs_with_filters.R         79      36  54.43%   34-74, 106, 122
R/module_teal_with_splash.R         114      34  70.18%   60-95, 110, 131, 197-198
R/module_teal.R                     120      84  30.00%   50-117, 148-149, 155-158, 171, 185-223
R/module_wunder_bar.R                60      39  35.00%   23-41, 55-64, 68-77
R/modules.R                         159      23  85.53%   127-130, 147-151, 206-209, 291-292, 344, 356-364
R/reporter_previewer_module.R        19       2  89.47%   30, 34
R/show_rcode_modal.R                 24      24  0.00%    17-42
R/tdata.R                            53       1  98.11%   154
R/teal_data_module-eval_code.R       27       0  100.00%
R/teal_data_module-within.R           7       0  100.00%
R/teal_data_module.R                  6       0  100.00%
R/teal_reporter.R                    68       6  91.18%   69, 77, 125-126, 129, 146
R/teal_slices-store.R                29       0  100.00%
R/teal_slices.R                      59      12  79.66%   137-150
R/TealAppDriver.R                   324     324  0.00%    43-671
R/utils.R                           185       1  99.46%   278
R/validate_inputs.R                  32       0  100.00%
R/validations.R                      58      37  36.21%   110-377
R/zzz.R                              12       8  33.33%   3-15
TOTAL                              2286    1119  51.05%

Diff against main

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

Results for commit: e4757dd0a6ea3db30f882cf9e0f76d93449eb9ae

Minimum allowed coverage is 80%

:recycle: This comment has been updated with latest results

github-actions[bot] commented 1 month ago

Unit Tests Summary

1 files 30 suites 4m 11s :stopwatch: 240 tests 240 :white_check_mark: 0 :zzz: 0 :x: 505 runs 505 :white_check_mark: 0 :zzz: 0 :x:

Results for commit e4757dd0.

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

github-actions[bot] commented 1 month ago

Unit Test Performance Difference

Test Suite	$Status$	Time on `main`	$±Time$	$±Tests$	$±Skipped$	$±Failures$	$±Errors$
shinytest2-filter_panel	💚	$33.73$	$-8.52$	$0$	$0$	$0$	$0$
shinytest2-landing_popup	💚	$21.19$	$-1.11$	$0$	$0$	$0$	$0$
shinytest2-module_bookmark_manager	💚	$27.64$	$-2.04$	$0$	$0$	$0$	$0$
shinytest2-modules	💚	$22.16$	$-1.15$	$0$	$0$	$0$	$0$
shinytest2-reporter	💚	$41.00$	$-1.17$	$0$	$0$	$0$	$0$
shinytest2-teal_data_module	💚	$25.24$	$-3.31$	$0$	$0$	$0$	$0$
shinytest2-teal_slices	💚	$54.05$	$-1.54$	$0$	$0$	$0$	$0$

Additional test case details

| Test Suite | $Status$ | Time on `main` | $±Time$ | Test Case | |:-----|:----:|:----:|:----:|:-----| | shinytest2-filter_panel | 💚 | $13.37$ | $-3.41$ | e2e_filtering_a_module_specific_filter_is_not_refected_in_other_unshared_modules | | shinytest2-filter_panel | 💚 | $14.41$ | $-4.35$ | e2e_filtering_a_module_specific_filter_is_refected_in_other_shared_module | | shinytest2-teal_data_module | 💚 | $10.40$ | $-2.99$ | e2e_teal_data_module_will_have_a_delayed_load_of_datasets | | shinytest2-teal_slices | 💚 | $34.77$ | $-1.38$ | e2e_teal_slices_filters_are_initialized_when_module_specific_filters_are_created |

Results for commit 08b53468c42ddcced2577f336ef2257d6e03b582

♻️ This comment has been updated with latest results.

insightsengineering / teal