Pre-release activities

[donyunardi]

Fixes #237

• [x] Review and update:
  • [x] README.md (check example code)
  • [x] NEWS.md
• [x] Run urlchecker::url_check() to identify broken links and fix
• [x] Review functions:
  • [x] @example tag, make sure it runs, fix if otherwise
  • [x] Make sure functions has @return tag to document the return value
  • [x] no \dontrun tag, replace with if(interactive()) if needed
• [x] Sanity check of all vignettes, make sure there is no typo, no wrong format, etc.
• [x] Run R CMD check --as-cran make sure everything pass
• [x] Package Title is not duplicated in Package Description in DESCRIPTION file (e.g. this happens in teal.slice currently)
• [x] All package names in Title and Description fields of DESCRIPTION file are quoted with '
• [x] You have checked the Package Release Template https://github.com/insightsengineering/teal.reporter/pull/205/files
• [x] Make sure there are no ::: in examples
  • [x] if you need to retain the example that uses :::, use getFromNamespace() function.
• [x] Make sure all teal.* mentions are lower-cased and quoted
• [x] Make Sure inst/WORDLIST is minimalized
• [ ] Make sure non-exported functions do not have examples
• [x] Make sure each link to our documentation hosted with pkgdown on github pages do not have /main/ in the address but it has /latest/ instead, so we always expose the documentation of the latest release and not what's currently on main branch but not yet released
• [x] Correct author list
• [x] Change teal.reporter.R to remove @docType in favor of "_PACKAGE"
• [x] Spellcheck NEWS.md catched -> caught
  • [x] Update WORDLIST
  • [x] (should remove roche, hallal, catched)

[github-actions[bot]]

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%   52-58
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, 109
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            113      37  67.26%   87-102, 203, 211, 220, 222-243
R/ReportCard.R           77       4  94.81%   181, 220, 225, 246
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               171      80  53.22%   7, 38-97, 99, 102-109, 163, 175-177, 287-296
R/yaml_utils.R           81       2  97.53%   70, 268
R/zzz.R                  14      10  28.57%   2-13, 19
TOTAL                  1406     245  82.57%

Diff against main

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

Results for commit: a4a60dbc02126190eb58983ac10e146a866c592e

Minimum allowed coverage is 80%

:recycle: This comment has been updated with latest results

[github-actions[bot]]

Unit Tests Summary

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

Results for commit a4a60dbc.

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

[kartikeyakirar]

@vedhav and @donyunardi I have raised a PR for additional changes. These changes are to keep it consistent with the last few pre-release cleanup. Please take a look and let me know your thoughts. https://github.com/insightsengineering/teal.reporter/pull/247

[donyunardi]

Per discussion, I will merge this first and @kartikeyakirar's PR will merge to main as that will require more time to review.