search

insightsengineering / teal.reporter

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

Update Installation section for CRAN + other updates of readme #213

Closed m7pr closed 1 year ago

m7pr commented 1 year ago

After package was released on CRAN #209 #208 I would recommend using CRAN as the main point for our packages installation. r-universe can be the source for the development version.

This also aims to update readme, as listed in here https://github.com/insightsengineering/coredev-tasks/issues/462

TODO: gif on the usage of shiny app with teal.reporter module

github-actions[bot] commented 1 year ago

Unit Tests Summary

    1 files    18 suites   12s :stopwatch: 195 tests 195 :heavy_check_mark: 0 :zzz: 0 :x: 334 runs  334 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit fae93fb6.

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

github-actions[bot] commented 1 year ago

badge

Code Coverage Summary

Filename              Stmts    Miss  Cover    Missing
------------------  -------  ------  -------  ----------------------------------------------------------------------------------
R/AddCardModule.R       140       1  99.29%   195
R/Archiver.R             25       0  100.00%
R/ContentBlock.R         18       2  88.89%   38-44
R/DownloadModule.R      207      49  76.33%   89-95, 138, 163-168, 177-181, 184-188, 196-200, 203-207, 214-218, 221-225, 262-266
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%   183, 197, 199-202, 205, 208-216, 325-369
R/RcodeBlock.R           15       0  100.00%
R/Renderer.R             84      13  84.52%   95, 103, 112, 114-126
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       29       0  100.00%
R/TableBlock.R            8       0  100.00%
R/TextBlock.R            13       0  100.00%
R/utils.R                78      66  15.38%   7, 38-97, 99, 102-109
R/yaml_utils.R           74       2  97.30%   41, 239
TOTAL                  1257     196  84.41%

Diff against main

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

Results for commit: 82f044bb565be0c9ab177331439e89788ff6e74d

Minimum allowed coverage is 80%

:recycle: This comment has been updated with latest results

m7pr commented 1 year ago

Still in TODO: gif on the usage of shiny app with teal.reporter module

m7pr commented 1 year ago

gif added here assets/img/showcase.gif https://github.com/insightsengineering/teal.reporter/blob/a3780089d28382c4e761111ad6bb0f6d0ee0d9ce/assets/img/showcase.gif