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

DESCRIPTION

@@ -48,18 +48,18 @@ Imports:
     shinyjs (>= 2.1.0),
     shinyvalidate (>= 0.1.3),
     stats,
-    teal.code (>= 0.6.1),
+    teal.code (>= 0.6.1.9002),
     teal.logger (>= 0.4.0),
     teal.reporter (>= 0.4.0.9004),
-    teal.widgets (>= 0.4.3.9001)
+    teal.widgets (>= 0.4.3.9001),
 Suggests:
     knitr (>= 1.42),
     nestcolor (>= 0.1.0),
     rmarkdown (>= 2.23),
     rvest (>= 1.0.0),
     shinytest2 (>= 0.4.1),
     stringr (>= 1.4.1),
-    teal.data (>= 0.7.0),
+    teal.data (>= 0.7.0.9002),
     tern (>= 0.9.7),
     testthat (>= 3.2.3),
     utils
@@ -68,9 +68,11 @@ VignetteBuilder:
     rmarkdown
 Remotes:
     insightsengineering/goshawk,
-    insightsengineering/teal,
-    insightsengineering/teal.reporter,
-    insightsengineering/teal.widgets
+    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/goshawk, rstudio/shiny,
     insightsengineering/teal, insightsengineering/teal.slice,
     insightsengineering/teal.transform, mllg/checkmate,

R/tm_g_gh_boxplot.R

@@ -42,6 +42,8 @@
 #' @author Jeff Tomlinson (tomlinsj) [email protected]
 #' @author Balazs Toth (tothb2) [email protected]
 #'
+#' @inheritSection teal::example_module Reporting
+#'
 #' @return an \code{\link[teal]{module}} object
 #'
 #' @export
@@ -240,9 +242,6 @@ ui_g_boxplot <- function(id, ...) {
       )
     ),
     encoding = tags$div(
-      ### Reporter
-      teal.reporter::simple_reporter_ui(ns("simple_reporter")),
-      ###
       templ_ui_dataname(a$dataname),
       uiOutput(ns("axis_selections")),
       templ_ui_constraint(ns, label = "Data Constraint"), # required by constr_anl_q
@@ -286,8 +285,6 @@ ui_g_boxplot <- function(id, ...) {
 
 srv_g_boxplot <- function(id,
                           data,
-                          reporter,
-                          filter_panel_api,
                           dataname,
                           param_var,
                           trt_group,
@@ -298,8 +295,6 @@ srv_g_boxplot <- function(id,
                           hline_vars_colors,
                           hline_vars_labels,
                           module_args) {
-  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")
 
@@ -382,7 +377,6 @@ srv_g_boxplot <- function(id,
 
     create_plot <- debounce(reactive({
       teal::validate_inputs(iv_r())
-
       req(anl_q())
       # nolint start
       param <- input$xaxis_param
@@ -425,7 +419,15 @@ srv_g_boxplot <- function(id,
         )
       }
 
-      anl_q()$qenv %>% teal.code::eval_code(
+      obj <- anl_q()$qenv
+      teal.reporter::teal_card(obj) <-
+        c(
+          teal.reporter::teal_card("# Box Plot"),
+          teal.reporter::teal_card(obj),
+          teal.reporter::teal_card("## Plot")
+        )
+
+      obj %>% teal.code::eval_code(
         code = bquote({
           p <- goshawk::g_boxplot(
             data = ANL,
@@ -511,40 +513,7 @@ srv_g_boxplot <- function(id,
 
     code <- reactive(teal.code::get_code(joined_qenvs()))
 
-    ### REPORTER
-    if (with_reporter) {
-      card_fun <- function(comment, label) {
-        constraint_description <- paste(
-          "\nFacet By:",
-          if (length(input$facet_var) != 0) input$facet_var else "None",
-          "\nSelect an X-axis Variable:",
-          input$xaxis_var
-        )
-        card <- report_card_template_goshawk(
-          title = "Box Plot",
-          label = label,
-          with_filter = with_filter,
-          filter_panel_api = filter_panel_api,
-          constraint_list = list(
-            constraint_var = input$constraint_var,
-            constraint_range_min = input$constraint_range_min,
-            constraint_range_max = input$constraint_range_max
-          ),
-          constraint_description = constraint_description,
-          style = "verbatim"
-        )
-        card$append_text("Plot", "header3")
-        card$append_plot(plot_r(), dim = boxplot_data$dim())
-        if (!comment == "") {
-          card$append_text("Comment", "header3")
-          card$append_text(comment)
-        }
-        card$append_src(code())
-        card
-      }
-      teal.reporter::simple_reporter_srv("simple_reporter", reporter = reporter, card_fun = card_fun)
-    }
-    ###
+
 
     # highlight plot area
     reactive_df <- debounce(reactive({
@@ -583,5 +552,6 @@ srv_g_boxplot <- function(id,
       verbatim_content = reactive(code()),
       title = "Show R Code for Boxplot"
     )
+    create_plot
   })
 }

R/tm_g_gh_correlationplot.R

@@ -50,6 +50,9 @@
 #' @author Nick Paszty (npaszty) [email protected]
 #' @author Balazs Toth (tothb2)  [email protected]
 #'
+#' @inheritSection teal::example_module Reporting
+#'
+#'
 #' @examples
 #' # Example using ADaM structure analysis dataset.
 #' data <- teal_data()
@@ -278,9 +281,6 @@ ui_g_correlationplot <- function(id, ...) {
   teal.widgets::standard_layout(
     output = templ_ui_output_datatable(ns),
     encoding = tags$div(
-      ### Reporter
-      teal.reporter::simple_reporter_ui(ns("simple_reporter")),
-      ###
       templ_ui_dataname(a$dataname),
       uiOutput(ns("axis_selections")),
       templ_ui_constraint(ns, "X-Axis Data Constraint"), # required by constr_anl_q
@@ -351,8 +351,6 @@ ui_g_correlationplot <- function(id, ...) {
 
 srv_g_correlationplot <- function(id,
                                   data,
-                                  reporter,
-                                  filter_panel_api,
                                   dataname,
                                   param_var,
                                   trt_group,
@@ -366,8 +364,6 @@ srv_g_correlationplot <- function(id,
                                   vline_vars_colors,
                                   vline_vars_labels,
                                   module_args) {
-  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")
 
@@ -774,8 +770,16 @@ srv_g_correlationplot <- function(id,
       validate(need(input$trt_group, "Please select a treatment variable"))
       trt_group <- input$trt_group
 
+      obj <- plot_data_transpose()$qenv
+      teal.reporter::teal_card(obj) <-
+        c(
+          teal.reporter::teal_card("# Correlation Plot"),
+          teal.reporter::teal_card(obj),
+          teal.reporter::teal_card("## Plot")
+        )
+
       teal.code::eval_code(
-        object = plot_data_transpose()$qenv,
+        object = obj,
         code = bquote({
           # re-establish treatment variable label
           p <- goshawk::g_correlationplot(
@@ -835,40 +839,7 @@ srv_g_correlationplot <- function(id,
 
     code <- reactive(teal.code::get_code(plot_q()))
 
-    ### REPORTER
-    if (with_reporter) {
-      card_fun <- function(comment, label) {
-        constraint_description <- paste(
-          "\nTreatment Variable Faceting:",
-          input$trt_facet,
-          "\nRegression Line:",
-          input$reg_line
-        )
-        card <- report_card_template_goshawk(
-          title = "Correlation Plot",
-          label = label,
-          with_filter = with_filter,
-          filter_panel_api = filter_panel_api,
-          constraint_list = list(
-            constraint_var = input$constraint_var,
-            constraint_range_min = input$constraint_range_min,
-            constraint_range_max = input$constraint_range_max
-          ),
-          constraint_description = constraint_description,
-          style = "verbatim"
-        )
-        card$append_text("Plot", "header3")
-        card$append_plot(plot_r(), dim = plot_data$dim())
-        if (!comment == "") {
-          card$append_text("Comment", "header3")
-          card$append_text(comment)
-        }
-        card$append_src(code())
-        card
-      }
-      teal.reporter::simple_reporter_srv("simple_reporter", reporter = reporter, card_fun = card_fun)
-    }
-    ###
+
 
     reactive_df <- debounce(reactive({
       req(iv_r()$is_valid())
@@ -900,5 +871,6 @@ srv_g_correlationplot <- function(id,
       verbatim_content = reactive(code()),
       title = "Show R Code for Correlation Plot"
     )
+    plot_q
   })
 }

R/tm_g_gh_density_distribution_plot.R

@@ -28,6 +28,7 @@
 #'
 #' @author Nick Paszty (npaszty) [email protected]
 #' @author Balazs Toth (tothb2)  [email protected]
+#' @inheritSection teal::example_module Reporting
 #'
 #' @details None
 #'
@@ -191,9 +192,6 @@ ui_g_density_distribution_plot <- function(id, ...) {
       )
     ),
     encoding = tags$div(
-      ### Reporter
-      teal.reporter::simple_reporter_ui(ns("simple_reporter")),
-      ###
       templ_ui_dataname(a$dataname),
       uiOutput(ns("axis_selections")),
       templ_ui_constraint(ns, label = "Data Constraint"),
@@ -237,8 +235,6 @@ ui_g_density_distribution_plot <- function(id, ...) {
 
 srv_g_density_distribution_plot <- function(id, # nolint
                                             data,
-                                            reporter,
-                                            filter_panel_api,
                                             dataname,
                                             param_var,
                                             param,
@@ -248,8 +244,6 @@ srv_g_density_distribution_plot <- function(id, # nolint
                                             plot_height,
                                             plot_width,
                                             module_args) {
-  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")
 
@@ -341,8 +335,16 @@ srv_g_density_distribution_plot <- function(id, # nolint
       # nolint end
 
 
+      obj <- anl_q()$qenv
+      teal.reporter::teal_card(obj) <-
+        c(
+          teal.reporter::teal_card("# Density Distribution Plot"),
+          teal.reporter::teal_card(obj),
+          teal.reporter::teal_card("## Plot")
+        )
+
       teal.code::eval_code(
-        object = anl_q()$qenv,
+        object = obj,
         code = bquote({
           p <- goshawk::g_density_distribution_plot(
             data = ANL,
@@ -370,14 +372,16 @@ srv_g_density_distribution_plot <- function(id, # nolint
 
     create_table <- debounce(reactive({
       req(iv_r()$is_valid())
-      req(anl_q())
+      req(create_plot())
       param <- input$xaxis_param
       xaxis_var <- input$xaxis_var
       font_size <- input$font_size
       trt_group <- input$trt_group
 
+      obj <- create_plot()
+      teal.reporter::teal_card(obj) <- c(teal.reporter::teal_card(obj), "## Descriptive Statistics")
       teal.code::eval_code(
-        object = anl_q()$qenv,
+        object = obj,
         code = bquote({
           tbl <- goshawk::t_summarytable(
             data = ANL,
@@ -414,48 +418,14 @@ srv_g_density_distribution_plot <- function(id, # nolint
         DT::formatRound(numeric_cols, 2)
     })
 
-    joined_qenvs <- reactive({
-      req(create_plot(), create_table())
-      c(create_plot(), create_table())
-    })
-
-    code <- reactive(teal.code::get_code(joined_qenvs()))
+    code <- reactive(teal.code::get_code(create_table()))
 
     teal.widgets::verbatim_popup_srv(
       id = "rcode",
       verbatim_content = reactive(code()),
       title = "Show R Code for Density Distribution Plot"
     )
 
-    ### REPORTER
-    if (with_reporter) {
-      card_fun <- function(comment, label) {
-        card <- report_card_template_goshawk(
-          title = "Density Distribution Plot",
-          label = label,
-          with_filter = with_filter,
-          filter_panel_api = filter_panel_api,
-          constraint_list = list(
-            constraint_var = input$constraint_var,
-            constraint_range_min = input$constraint_range_min,
-            constraint_range_max = input$constraint_range_max
-          )
-        )
-        card$append_text("Plot", "header3")
-        card$append_plot(plot_r(), dim = plot_data$dim())
-        card$append_text("Descriptive Statistics", "header3")
-        card$append_table(
-          create_table()[["tbl"]] %>% dplyr::mutate_if(is.numeric, round, 2)
-        )
-        if (!comment == "") {
-          card$append_text("Comment", "header3")
-          card$append_text(comment)
-        }
-        card$append_src(code())
-        card
-      }
-      teal.reporter::simple_reporter_srv("simple_reporter", reporter = reporter, card_fun = card_fun)
-    }
-    ###
+    create_table
   })
 }