📑 Refactor: Adds new teal_report, teal_card class and revamps reporter UI (#331)

# Pull Request

Fixes:

- insightsengineering/teal#1526

Built on top of:

- #307
    - _(#307 will be closed once this PR is stable)_

### Companion PRs:

- insightsengineering/teal#1541
- insightsengineering/teal.code#255
- insightsengineering/teal.data#370
- #331
- insightsengineering/teal.modules.general#884
- insightsengineering/teal.modules.clinical#1392

### Changes description

- Adds new object called `teal_report` that extends `teal_data`
- The card/report for a module is built automatically with `eval_code()`
and `eval_code(cache = TRUE)`
        - (adding code and print objects respectively)
    - Report slot can be manipulated with `report(<teal_report>)`
- Rename of `report_document` to `doc`/`document`/`page` (final name
TBD)

---------

Signed-off-by: Marcin <[email protected]>
Signed-off-by: André Veríssimo <[email protected]>
Co-authored-by: m7pr <[email protected]>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Dawid Kaledkowski <[email protected]>
Co-authored-by: Marcin <[email protected]>
Co-authored-by: vedhav <[email protected]>
Co-authored-by: Lluís Revilla <[email protected]>
Co-authored-by: Pawel Rucki <[email protected]>

Author: 7 people

.lintr

@@ -1,6 +1,5 @@
 linters: linters_with_defaults(
   line_length_linter = line_length_linter(120),
-  cyclocomp_linter = NULL,
   object_usage_linter = NULL,
   indentation_linter = NULL
   )

.pre-commit-config.yaml

@@ -14,25 +14,32 @@ repos:
       - id: roxygenize
         name: Regenerate package documentation
         additional_dependencies:
+          - bsicons
           - bslib
           - checkmate
-          #- flextable
-          - davidgohel/flextable # Error: package 'flextable' is not available
-          - davidgohel/gdtools # for flextable
+          - commonmark
+          - flextable
           - grid
-          - htmltools
+          - gtsummary
           - knitr
           - lifecycle
           - R6
+          - rlang
+          - insightsengineering/rlistings # for rtables
           - rmarkdown
+          - insightsengineering/rtables
+          - insightsengineering/rtables.officer
+          - davidgohel/officer # for rtables.officer
+          - insightsengineering/formatters # for rtables
           - shiny
           - shinybusy
+          - shinyjs
           - shinyWidgets
+          - sortable
+          - insightsengineering/teal.code
+          - insightsengineering/teal.data
           - yaml
           - zip
-          - rlistings
-          - rtables
-          - rtables.officer
       - id: spell-check
         name: Check spelling with `spelling`
         exclude: >

DESCRIPTION

@@ -25,21 +25,30 @@ Imports:
     bsicons,
     bslib (>= 0.8.0),
     checkmate (>= 2.1.0),
+    commonmark (>= 1.9.2),
     flextable (>= 0.9.2),
     grid,
+    gtsummary (>= 1.7.0),
     htmltools (>= 0.5.4),
+    jsonlite (>= 1.8.9),
     knitr (>= 1.42),
     lifecycle (>= 0.2.0),
+    methods,
     R6,
+    rlang (>= 1.0.0),
     rlistings (>= 0.2.10),
     rmarkdown (>= 2.23),
     rtables (>= 0.6.11),
     rtables.officer (>= 0.0.2),
     shiny (>= 1.8.1),
     shinybusy (>= 0.3.2),
-    shinyjs,
+    shinyjs (>= 2.1.0),
     shinyWidgets (>= 0.5.1),
     sortable (>= 0.5.0),
+    teal.code (>= 0.6.1.9002),
+    teal.data (>= 0.7.0.9002),
+    tools,
+    utils,
     yaml (>= 1.1.0),
     zip (>= 1.1.0)
 Suggests:
@@ -49,25 +58,29 @@ Suggests:
     ggplot2 (>= 3.4.3),
     lattice (>= 0.18-4),
     png,
+    shinytest2,
     testthat (>= 3.2.2),
     tinytex,
+    waldo (>= 0.2.0),
     withr (>= 2.0.0)
 VignetteBuilder:
     knitr,
     rmarkdown
-RdMacros:
-    lifecycle
-Config/Needs/verdepcheck: rstudio/bslib, mllg/checkmate,
-    davidgohel/flextable, rstudio/htmltools, yihui/knitr, r-lib/lifecycle,
-    r-lib/R6, insightsengineering/rlistings, rstudio/rmarkdown,
+Config/Needs/verdepcheck: rstudio/bsicons,rstudio/bslib, mllg/checkmate,
+    r-lib/commonmark, davidgohel/flextable, ddsjoberg/gtsummary, rstudio/htmltools,
+    jeroen/jsonlite, yihui/knitr, r-lib/lifecycle, r-lib/R6, r-lib/rlang,
+    insightsengineering/rlistings, rstudio/rmarkdown,
     insightsengineering/rtables, insightsengineering/rtables.officer,
-    rstudio/shiny, dreamRs/shinybusy, dreamRs/shinyWidgets,
+    rstudio/shiny, dreamRs/shinybusy, daattali/shinyjs, dreamRs/shinyWidgets,
+    rstudio/sortable, insightsengineering/teal.code, insightsengineering/teal.data,
     yaml=vubiostat/r-yaml, r-lib/zip, rstudio/DT, yihui/formatR,
     insightsengineering/formatters, tidyverse/ggplot2, deepayan/lattice,
-    cran/png, r-lib/testthat, rstudio/tinytex, r-lib/withr
+    cran/png, rstudio/shinytest2, r-lib/testthat, rstudio/tinytex, r-lib/waldo,
+    r-lib/withr
 Config/Needs/website: insightsengineering/nesttemplate
 Encoding: UTF-8
 Language: en-US
 LazyData: true
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.2
+Config/testthat/edition: 3

NAMESPACE

@@ -1,15 +1,40 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method("[",teal_card)
+S3method("[",teal_report)
+S3method("[[<-",teal_card)
+S3method("metadata<-",ReportCard)
+S3method("metadata<-",teal_card)
+S3method(c,teal_card)
+S3method(c,teal_report)
+S3method(format,code_chunk)
+S3method(length,ReportCard)
+S3method(metadata,ReportCard)
+S3method(metadata,teal_card)
 S3method(print,rmd_yaml_header)
+S3method(srv_editor_block,default)
+S3method(teal_card,default)
+S3method(teal_card,qenv)
+S3method(teal_card,teal_card)
+S3method(teal_card,teal_report)
+S3method(toHTML,default)
+S3method(ui_editor_block,default)
+export("metadata<-")
+export("teal_card<-")
 export(ReportCard)
 export(Reporter)
 export(add_card_button_srv)
 export(add_card_button_ui)
+export(as.teal_card)
+export(as.teal_report)
 export(as_yaml_auto)
+export(code_chunk)
 export(download_report_button_srv)
 export(download_report_button_ui)
+export(metadata)
 export(preview_report_button_srv)
 export(preview_report_button_ui)
+export(render)
 export(report_load_srv)
 export(report_load_ui)
 export(reporter_previewer_srv)
@@ -20,9 +45,10 @@ export(rmd_output_arguments)
 export(rmd_outputs)
 export(simple_reporter_srv)
 export(simple_reporter_ui)
-importFrom(R6,R6Class)
-importFrom(checkmate,assert_string)
-importFrom(grid,grid.newpage)
-importFrom(lifecycle,badge)
-importFrom(rmarkdown,render)
-importFrom(yaml,as.yaml)
+export(srv_editor_block)
+export(teal_card)
+export(teal_report)
+export(ui_editor_block)
+importFrom(teal.code,eval_code)
+importFrom(teal.data,teal_data)
+importFrom(tools,toHTML)

NEWS.md

@@ -1,5 +1,13 @@
 # teal.reporter 0.5.0.9000
 
+### New features
+
+* Adds editing capabilities to report cards in the previewer modal for the title and text contents.
+* Adds `teal_card` class that replaces `ReportCard` R6 class. It retains all its functionalities in a S4 with less complexity. It allows for easier modifications and insertion of new report content.
+* Adds `teal_report` class that extends from `teal.data::teal_data` that allows to keep contents of the report card.
+* `teal_report` is updated automatically with executed code and its outputs are stored as well.
+* Supports `flextable` and `gtsummary` objects.
+
 # teal.reporter 0.5.0
 
 ### Breaking changes