📑 Refactor: Adds new teal_report, teal_card class and revamps reporter UI

.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

@@ -6,7 +6,7 @@ default_language_version:
   python: python3
 repos:
   - repo: https://github.com/lorenzwalthert/precommit
-    rev: v0.4.3.9005
+    rev: v0.4.3.9009
     hooks:
       - id: style-files
         name: Style code with `styler`
@@ -16,23 +16,27 @@ repos:
         additional_dependencies:
           - bslib
           - checkmate
-          #- flextable
-          - davidgohel/flextable # Error: package 'flextable' is not available
-          - davidgohel/gdtools # for flextable
+          - commonmark
+          - flextable
           - grid
-          - htmltools
           - knitr
           - lifecycle
           - R6
+          - 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.data
+          - insightsengineering/teal.code
           - yaml
           - zip
-          - rlistings
-          - rtables
-          - rtables.officer
       - id: spell-check
         name: Check spelling with `spelling`
         exclude: >

DESCRIPTION

@@ -24,41 +24,55 @@ BugReports: https://github.com/insightsengineering/teal.reporter/issues
 Imports:
     bslib (>= 0.8.0),
     checkmate (>= 2.1.0),
+    commonmark (>= 1.9.2),
     flextable (>= 0.9.2),
     grid,
     htmltools (>= 0.5.4),
     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.6.0),
     shinybusy (>= 0.3.2),
+    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:
+    chromote,
     DT (>= 0.13),
     formatR (>= 1.5),
     formatters (>= 0.5.10),
     ggplot2 (>= 3.4.3),
     lattice (>= 0.18-4),
+    lifecycle (>= 0.2.0),
     png,
+    shinytest2,
     testthat (>= 3.2.2),
     tinytex,
+    waldo (>= 0.2.0),
     withr (>= 2.0.0)
 VignetteBuilder:
     knitr,
     rmarkdown
-RdMacros:
-    lifecycle
+Remotes:
+    insightsengineering/teal.code@main,
+    insightsengineering/teal.data@main
 Config/Needs/verdepcheck: rstudio/bslib, mllg/checkmate,
-    davidgohel/flextable, rstudio/htmltools, yihui/knitr, r-lib/lifecycle,
-    r-lib/R6, insightsengineering/rlistings, rstudio/rmarkdown,
+    davidgohel/flextable, 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
@@ -68,3 +82,34 @@ Language: en-US
 LazyData: true
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.2
+Config/testthat/edition: 3
+Collate: 
+    'Reporter.R'
+    'AddCardModule.R'
+    'ContentBlock.R'
+    'DownloadModule.R'
+    'Editor.R'
+    'FileBlock.R'
+    'HTMLBlock.R'
+    'LoadReporterModule.R'
+    'NewpageBlock.R'
+    'PictureBlock.R'
+    'Previewer.R'
+    'RcodeBlock.R'
+    'Renderer.R'
+    'ReportCard.R'
+    'ResetModule.R'
+    'SimpleReporter.R'
+    'TableBlock.R'
+    'TextBlock.R'
+    'teal_card.R'
+    'teal.reporter.R'
+    'teal_report-class.R'
+    'teal_report-c.R'
+    'teal_report-eval_code.R'
+    'teal_report-extract.R'
+    'toHTML.R'
+    'to_rmd.R'
+    'utils.R'
+    'yaml_utils.R'
+    'zzz.R'

NAMESPACE

@@ -1,13 +1,31 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method("[",teal_card)
+S3method("[",teal_report)
+S3method("metadata<-",ReportCard)
+S3method("metadata<-",teal_card)
+S3method(c,teal_card)
+S3method(c,teal_report)
+S3method(length,ReportCard)
+S3method(metadata,ReportCard)
+S3method(metadata,teal_card)
 S3method(print,rmd_yaml_header)
+S3method(srv_editor_block,default)
+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(report_load_srv)
 export(report_load_ui)
 export(reporter_previewer_srv)
@@ -18,9 +36,11 @@ export(rmd_output_arguments)
 export(rmd_outputs)
 export(simple_reporter_srv)
 export(simple_reporter_ui)
+export(srv_editor_block)
+export(teal_card)
+export(teal_report)
+export(ui_editor_block)
 importFrom(R6,R6Class)
-importFrom(checkmate,assert_string)
-importFrom(grid,grid.newpage)
-importFrom(lifecycle,badge)
-importFrom(rmarkdown,render)
-importFrom(yaml,as.yaml)
+importFrom(teal.code,eval_code)
+importFrom(teal.data,teal_data)
+importFrom(tools,toHTML)

R/AddCardModule.R

@@ -8,17 +8,17 @@
 #'
 #' @details
 #' The `card_fun` function is designed to create a new `ReportCard` instance and optionally customize it:
-#' - The `card` parameter allows for specifying a custom or default `ReportCard` instance.
+#' - The `teal_card` parameter allows for specifying a custom or default `ReportCard` instance.
 #' - Use the `comment` parameter to add a comment to the card via `card$append_text()` - if `card_fun` does not
 #' have the `comment` parameter, then `comment` from `Add Card UI` module will be added at the end of the content of the
 #' card.
 #' - The `label` parameter enables customization of the card's name and its content through `card$append_text()`-
 #' if `card_fun` does not have the `label` parameter, then card name will be set to the name passed in
-#' `Add Card UI` module, but no text will be added to the content of the `card`.
+#' `Add Card UI` module, but no text will be added to the content of the `teal_card`.
 #'
 #' This module supports using a subclass of [`ReportCard`] for added flexibility.
 #' A subclass instance should be passed as the default value of
-#' the `card` argument in the `card_fun` function.
+#' the `teal_card` argument in the `card_fun` function.
 #' See below:
 #' ```{r}
 #' CustomReportCard <- R6::R6Class(
@@ -47,9 +47,6 @@ add_card_button_ui <- function(id) {
   # Buttons with custom css and
   # js code to disable the add card button when clicked to prevent multi-clicks
   shiny::tagList(
-    shiny::singleton(
-      shiny::tags$head(shiny::includeCSS(system.file("css/custom.css", package = "teal.reporter")))
-    ),
     shiny::singleton(
       shiny::tags$head(
         shiny::tags$script(
@@ -69,12 +66,8 @@ add_card_button_ui <- function(id) {
     ),
     shiny::actionButton(
       ns("add_report_card_button"),
-      title = "Add Card",
-      class = "teal-reporter simple_report_button btn-primary",
-      `data-val` = shiny::restoreInput(id = ns("add_report_card_button"), default = NULL),
-      shiny::tags$span(
-        shiny::icon("plus")
-      )
+      "Add to Reporter",
+      `data-val` = shiny::restoreInput(id = ns("add_report_card_button"), default = NULL)
     )
   )
 }
@@ -118,14 +111,8 @@ add_card_button_srv <- function(id, reporter, card_fun) {
           ),
           shiny::tags$script(
             shiny::HTML(
-              sprintf(
-                "
-                $('#shiny-modal').on('shown.bs.modal', () => {
-                  $('#%s').focus()
-                })
-                ",
-                ns("label")
-              )
+              sprintf("shinyjs.autoFocusModal('%s');", ns("label")), # See extendShinyJs.js
+              sprintf("shinyjs.enterToSubmit('%s', '%s');", ns("label"), ns("add_card_ok")) # See extendShinyJs.js
             )
           ),
           footer = shiny::div(
@@ -198,14 +185,23 @@ add_card_button_srv <- function(id, reporter, card_fun) {
           type = "error"
         )
       } else {
-        checkmate::assert_class(card, "ReportCard")
-        if (!has_comment_arg && length(input$comment) > 0 && input$comment != "") {
-          card$append_text("Comment", "header3")
-          card$append_text(input$comment)
-        }
+        checkmate::assert_multi_class(card, c("ReportCard", "teal_card"))
+        if (inherits(card, "ReportCard")) {
+          if (!has_comment_arg && length(input$comment) > 0 && input$comment != "") {
+            card$append_text("Comment", "header3")
+            card$append_text(input$comment)
+          }
 
-        if (!has_label_arg && length(input$label) == 1 && input$label != "") {
-          card$set_name(input$label)
+          if (!has_label_arg && length(input$label) == 1 && input$label != "") {
+            card$set_name(input$label)
+          }
+        } else if (inherits(card, "teal_card")) {
+          if (!has_comment_arg && length(input$comment) > 0 && input$comment != "") {
+            card <- c(card, "### Comment", input$comment)
+          }
+          if (!has_label_arg && length(input$label) == 1 && input$label != "") {
+            metadata(card, "title") <- input$label
+          }
         }
 
         reporter$append_cards(list(card))