📑 Reporter Refactor: Adds support for new teal_report and teal_card class

DESCRIPTION

@@ -24,7 +24,7 @@ Depends:
     osprey (>= 0.1.17),
     R (>= 3.6),
     shiny (>= 1.6.0),
-    teal (>= 0.16.0),
+    teal (>= 0.16.0.9003),
     teal.transform (>= 0.6.0)
 Imports:
     bslib (>= 0.8.0),
@@ -34,11 +34,11 @@ Imports:
     ggplot2 (>= 3.4.0),
     lifecycle (>= 0.2.0),
     shinyvalidate,
-    teal.code (>= 0.6.1),
-    teal.data (>= 0.7.0),
+    teal.code (>= 0.6.1.9002),
+    teal.data (>= 0.7.0.9002),
     teal.logger (>= 0.4.0),
-    teal.reporter (>= 0.4.0),
-    teal.widgets (>= 0.4.3),
+    teal.reporter (>= 0.4.0.9004),
+    teal.widgets (>= 0.4.3.9001),
     tern (>= 0.9.7),
     tidyr (>= 0.8.3)
 Suggests:
@@ -48,7 +48,12 @@ Suggests:
     testthat (>= 3.2.3),
     withr (>= 2.0.0)
 Remotes:
-    insightsengineering/osprey
+    insightsengineering/osprey,
+    insightsengineering/teal.code@main,
+    insightsengineering/teal.data@main,
+    insightsengineering/teal@teal_reportable,
+    insightsengineering/teal.reporter@teal_reportable,
+    insightsengineering/teal.widgets@main
 Config/Needs/verdepcheck: insightsengineering/osprey, rstudio/shiny,
     insightsengineering/teal, insightsengineering/teal.slice,
     insightsengineering/teal.transform, mllg/checkmate, tidyverse/dplyr,

R/tm_g_ae_oview.R

@@ -13,6 +13,7 @@
 #'   sub-groups (e.g. Serious events, Related events, etc.)
 #'
 #' @inherit argument_convention return
+#' @inheritSection teal::example_module Reporting
 #'
 #' @export
 #'
@@ -129,9 +130,6 @@
       plot_decorate_output(id = ns(NULL))
     ),
     encoding = tags$div(
-      ### Reporter
-      teal.reporter::simple_reporter_ui(ns("simple_reporter")),
-      ###
       teal.widgets::optionalSelectInput(
         ns("arm_var"),
         "Arm Variable",
@@ -197,14 +195,10 @@
 
 srv_g_ae_oview <- function(id,
                            data,
-                           filter_panel_api,
-                           reporter,
                            dataname,
                            label,
                            plot_height,
                            plot_width) {
-  with_reporter <- !missing(reporter) && inherits(reporter, "Reporter")
-  with_filter <- !missing(filter_panel_api) && inherits(filter_panel_api, "FilterPanelAPI")
   checkmate::assert_class(data, "reactive")
   checkmate::assert_class(isolate(data()), "teal_data")
 
@@ -285,7 +279,15 @@
     output_q <- shiny::debounce(
       millis = 200,
       r = reactive({
-        ANL <- data()[[dataname]]
+        obj <- data()
+        teal.reporter::teal_card(obj) <- 
+          c(
+            teal.reporter::teal_card("# AE Overview"),
+            teal.reporter::teal_card(obj),
+            teal.reporter::teal_card("## Module's code")
+          )
+
+        ANL <- obj[[dataname]]
 
         teal::validate_has_data(ANL, min_nrow = 10, msg = sprintf("%s has not enough data", dataname))
 
@@ -297,7 +299,7 @@
         ))
 
         q1 <- teal.code::eval_code(
-          data(),
+          obj,
           code = as.expression(c(
             bquote(anl_labels <- formatters::var_labels(.(as.name(dataname)), fill = FALSE)),
             bquote(
@@ -308,6 +310,8 @@
           ))
         )
 
+        teal.reporter::teal_card(q1) <- c(teal.reporter::teal_card(q1), "## Plot")
+
         teal.code::eval_code(
           q1,
           code = as.expression(c(
@@ -339,25 +343,6 @@
       verbatim_content = reactive(teal.code::get_code(output_q())),
       title = paste("R code for", label)
     )
-    ### REPORTER
-    if (with_reporter) {
-      card_fun <- function(comment, label) {
-        card <- teal::report_card_template(
-          title = "AE Overview",
-          label = label,
-          with_filter = with_filter,
-          filter_panel_api = filter_panel_api
-        )
-        card$append_text("Plot", "header3")
-        card$append_plot(plot_r(), dim = pws$dim())
-        if (!comment == "") {
-          card$append_text("Comment", "header3")
-          card$append_text(comment)
-        }
-        card$append_src(teal.code::get_code(output_q()))
-        card
-      }
-      teal.reporter::simple_reporter_srv("simple_reporter", reporter = reporter, card_fun = card_fun)
-    }
+    output_q
   })
 }

R/tm_g_ae_sub.R

@@ -14,6 +14,7 @@
 #' @author Molly He (hey59) \email{[email protected]}
 #'
 #' @inherit argument_convention return
+#' @inheritSection teal::example_module Reporting
 #'
 #' @export
 #'
@@ -105,9 +106,6 @@
       plot_decorate_output(id = ns(NULL))
     ),
     encoding = tags$div(
-      ### Reporter
-      teal.reporter::simple_reporter_ui(ns("simple_reporter")),
-      ###
       tags$label("Encodings", class = "text-primary"),
       helpText("Analysis data:", tags$code("ADAE")),
       teal.widgets::optionalSelectInput(
@@ -175,14 +173,10 @@
 
 srv_g_ae_sub <- function(id,
                          data,
-                         filter_panel_api,
-                         reporter,
                          dataname,
                          label,
                          plot_height,
                          plot_width) {
-  with_reporter <- !missing(reporter) && inherits(reporter, "Reporter")
-  with_filter <- !missing(filter_panel_api) && inherits(filter_panel_api, "FilterPanelAPI")
   checkmate::assert_class(data, "reactive")
   checkmate::assert_class(shiny::isolate(data()), "teal_data")
 
@@ -317,8 +311,16 @@
     output_q <- shiny::debounce(
       millis = 200,
       r = reactive({
-        ANL <- data()[[dataname]]
-        ADSL <- data()[["ADSL"]]
+        obj <- data()
+        teal.reporter::teal_card(obj) <- 
+          c(
+            teal.reporter::teal_card("# AE by Subgroups"),
+            teal.reporter::teal_card(obj),
+            teal.reporter::teal_card("## Module's code")
+          )
+
+        ANL <- obj[[dataname]]
+        ADSL <- obj[["ADSL"]]
 
         teal::validate_has_data(ANL, min_nrow = 10, msg = sprintf("%s has not enough data", dataname))
 
@@ -347,10 +349,14 @@
           bquote(group_labels <- setNames(.(group_labels), .(input$groups)))
         }
 
-        teal.code::eval_code(data(), code = group_labels_call) %>%
-          teal.code::eval_code(code = "") %>%
-          teal.code::eval_code(
+        q1 <- teal.code::eval_code(obj, code = group_labels_call) %>%
+          teal.code::eval_code(code = "")
+
+        teal.reporter::teal_card(q1) <- c(teal.reporter::teal_card(q1), "## Plot")
+
+        teal.code::eval_code(
+          q1,
             code = as.expression(c(
               bquote(
                 plot <- osprey::g_ae_sub(
                   id = .(as.name(dataname))$USUBJID,
@@ -382,25 +388,6 @@
       title = paste("R code for", label),
     )
 
-    ### REPORTER
-    if (with_reporter) {
-      card_fun <- function(comment, label) {
-        card <- teal::report_card_template(
-          title = "AE Subgroups",
-          label = label,
-          with_filter = with_filter,
-          filter_panel_api = filter_panel_api
-        )
-        card$append_text("Plot", "header3")
-        card$append_plot(plot_r(), dim = pws$dim())
-        if (!comment == "") {
-          card$append_text("Comment", "header3")
-          card$append_text(comment)
-        }
-        card$append_src(teal.code::get_code(output_q()))
-        card
-      }
-      teal.reporter::simple_reporter_srv("simple_reporter", reporter = reporter, card_fun = card_fun)
-    }
+    output_q
   })
 }

R/tm_g_butterfly.R

@@ -34,6 +34,7 @@
 #'   used directly as filter.
 #'
 #' @inherit argument_convention return
+#' @inheritSection teal::example_module Reporting
 #'
 #' @export
 #'
@@ -166,9 +167,6 @@
       teal.widgets::plot_with_settings_ui(id = ns("butterflyplot"))
     ),
     encoding = tags$div(
-      ### Reporter
-      teal.reporter::simple_reporter_ui(ns("simple_reporter")),
-      ###
       tags$label("Encodings", class = "text-primary"),
       helpText("Dataset is:", tags$code(a$dataname)),
       if (!is.null(a$filter_var)) {
@@ -263,9 +261,7 @@
   )
 }
 
-srv_g_butterfly <- function(id, data, filter_panel_api, reporter, dataname, label, plot_height, plot_width) {
-  with_reporter <- !missing(reporter) && inherits(reporter, "Reporter")
-  with_filter <- !missing(filter_panel_api) && inherits(filter_panel_api, "FilterPanelAPI")
+srv_g_butterfly <- function(id, data, dataname, label, plot_height, plot_width) {
   checkmate::assert_class(data, "reactive")
   checkmate::assert_class(shiny::isolate(data()), "teal_data")
 
@@ -385,8 +381,16 @@
     output_q <- shiny::debounce(
       millis = 200,
       r = reactive({
-        ADSL <- data()[["ADSL"]]
-        ANL <- data()[[dataname]]
+        obj <- data()
+        teal.reporter::teal_card(obj) <- 
+          c(
+            teal.reporter::teal_card("# Butterfly Plot"),
+            teal.reporter::teal_card(obj),
+            teal.reporter::teal_card("## Module's code")
+          )
+
+        ADSL <- obj[["ADSL"]]
+        ANL <- obj[[dataname]]
 
         teal::validate_has_data(ADSL, min_nrow = 0, msg = sprintf("%s Data is empty", "ADSL"))
         teal::validate_has_data(ANL, min_nrow = 0, msg = sprintf("%s Data is empty", dataname))
@@ -422,7 +426,7 @@
         anl_vars <- unique(c("USUBJID", "STUDYID", varlist_from_anl))
 
         q1 <- teal.code::eval_code(
-          data(),
+          obj,
           code = bquote({
             ADSL <- ADSL[, .(adsl_vars)] %>% as.data.frame()
             ANL <- .(as.name(dataname))[, .(anl_vars)] %>% as.data.frame()
@@ -460,6 +464,8 @@
           )
         }
 
+        teal.reporter::teal_card(q1) <- c(teal.reporter::teal_card(q1), "## Plot")
+
         if (!is.null(right_val) && !is.null(left_val)) {
           q1 <- teal.code::eval_code(
             q1,
@@ -511,37 +517,6 @@
       verbatim_content = reactive(teal.code::get_code(output_q()))
     )
 
-    ### REPORTER
-    if (with_reporter) {
-      card_fun <- function(comment, label) {
-        card <- teal::report_card_template(
-          title = "Butterfly Plot",
-          label = label,
-          with_filter = with_filter,
-          filter_panel_api = filter_panel_api
-        )
-        if (!is.null(input$filter_var) || !is.null(input$facet_var) || !is.null(input$sort_by_var)) {
-          card$append_text("Selected Options", "header3")
-        }
-        if (!is.null(input$filter_var)) {
-          card$append_text(paste0("Preset Data Filters: ", paste(input$filter_var, collapse = ", "), "."))
-        }
-        if (!is.null(input$facet_var)) {
-          card$append_text(paste0("Faceted by: ", paste(input$facet_var, collapse = ", "), "."))
-        }
-        if (!is.null(input$sort_by_var)) {
-          card$append_text(paste0("Sorted by: ", paste(input$sort_by_var, collapse = ", "), "."))
-        }
-        card$append_text("Plot", "header3")
-        card$append_plot(plot_r(), dim = pws$dim())
-        if (!comment == "") {
-          card$append_text("Comment", "header3")
-          card$append_text(comment)
-        }
-        card$append_src(teal.code::get_code(output_q()))
-        card
-      }
-      teal.reporter::simple_reporter_srv("simple_reporter", reporter = reporter, card_fun = card_fun)
-    }
+    output_q
   })
 }