insightsengineering / teal.reporter

Create and preview reports with Shiny modules
https://insightsengineering.github.io/teal.reporter/
Other
8 stars 9 forks source link

198 extension to Include user's card labels when generating the report #224

Closed kartikeyakirar closed 9 months ago

kartikeyakirar commented 9 months ago

this PR is extension to https://github.com/insightsengineering/teal.reporter/issues/198

Here I have added card_template() function that generates a report card with a title, an optional description, and the option to append the filter state list. and is been used in https://github.com/insightsengineering/teal.modules.general https://github.com/insightsengineering/teal.modules.clinical https://github.com/insightsengineering/teal.modules.hermes https://github.com/insightsengineering/teal.osprey https://github.com/insightsengineering/teal.goshawk

github-actions[bot] commented 9 months ago

badge

Code Coverage Summary

Filename              Stmts    Miss  Cover    Missing
------------------  -------  ------  -------  -----------------------------------------------------------------------------------
R/AddCardModule.R       144       2  98.61%   162, 199
R/Archiver.R             25       0  100.00%
R/ContentBlock.R         18       2  88.89%   38-44
R/DownloadModule.R      207      49  76.33%   95-101, 143, 168-173, 182-186, 189-193, 201-205, 208-212, 219-223, 226-230, 267-271
R/FileBlock.R            13       0  100.00%
R/NewpageBlock.R          2       0  100.00%
R/PictureBlock.R         30       2  93.33%   15, 79
R/Previewer.R           295      56  81.02%   188, 202, 204-207, 210, 213-221, 330-374
R/RcodeBlock.R           15       0  100.00%
R/Renderer.R            116      22  81.03%   63, 124, 132, 141, 143-164
R/ReportCard.R           77       4  94.81%   180, 219, 224, 245
R/Reporter.R             94       1  98.94%   254
R/ResetModule.R          55       0  100.00%
R/SimpleReporter.R       30       0  100.00%
R/TableBlock.R            9       0  100.00%
R/TextBlock.R            13       0  100.00%
R/utils.R               185      94  49.19%   7, 38-97, 99, 102-109, 163, 175-177, 287-331
R/yaml_utils.R           81       2  97.53%   41, 239
R/zzz.R                  14      10  28.57%   2-13, 19
TOTAL                  1423     244  82.85%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  -------
R/utils.R       +14     +14  -4.03%
TOTAL           +14     +14  -0.82%

Results for commit: dd9644ce1c5be9d8353a0be950dc6a41bde5fdb9

Minimum allowed coverage is 80%

:recycle: This comment has been updated with latest results

github-actions[bot] commented 9 months ago

Unit Tests Summary

    1 files    18 suites   18s :stopwatch: 204 tests 204 :heavy_check_mark: 0 :zzz: 0 :x: 346 runs  346 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit dd9644ce.

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

kartikeyakirar commented 9 months ago

I am closing this pull request, referring to PR 933. After discussion, it seems more appropriate to relocate the card template functionality to the teal package.