`{teal}` module returns a `teal_report` object that extends from `teal_data` #884

averissimo · 2025-06-03T11:44:16Z

Pull Request

Fixes:

[Question]: How to return report to teal? teal#1526

Built on top of:

Redesign of teal.reporter Cards teal#1499 (will be closed once this PR is stable)

Companion PRs:

{teal} module returns a teal_report object that extends from teal_data teal#1541
{teal} module returns a teal_report object that extends from teal_data teal.code#255
{teal} module returns a teal_report object that extends from teal_data teal.data#370
{teal} module returns a teal_report object that extends from teal_data teal.reporter#331
{teal} module returns a teal_report object that extends from teal_data #884

Changes description

Return a teal_report object on every module
Remove old "Add to reporter" implementation in modules

github-actions · 2025-06-05T13:28:46Z

Code Coverage Summary

Filename                      Stmts    Miss  Cover    Missing
--------------------------  -------  ------  -------  --------------------------------------
R/tm_a_pca.R                    876     876  0.00%    141-1146
R/tm_a_regression.R             765     765  0.00%    180-1044
R/tm_data_table.R               201     201  0.00%    100-349
R/tm_file_viewer.R              172     172  0.00%    47-254
R/tm_front_page.R               144     133  7.64%    77-247
R/tm_g_association.R            327     327  0.00%    161-557
R/tm_g_bivariate.R              686     422  38.48%   332-811, 852, 963, 980, 998, 1009-1031
R/tm_g_distribution.R          1100    1100  0.00%    158-1400
R/tm_g_response.R               355     355  0.00%    179-609
R/tm_g_scatterplot.R            720     720  0.00%    261-1081
R/tm_g_scatterplotmatrix.R      283     264  6.71%    200-516, 577, 591
R/tm_missing_data.R            1095    1095  0.00%    126-1402
R/tm_outliers.R                1022    1022  0.00%    165-1337
R/tm_t_crosstable.R             269     269  0.00%    177-491
R/tm_variable_browser.R         803     798  0.62%    89-1044, 1082-1265
R/utils.R                       142     126  11.27%   87-272, 301-327, 339-348, 353, 367-386
R/zzz.R                           2       2  0.00%    2-3
TOTAL                          8962    8647  3.51%

Diff against main

Filename                      Stmts    Miss  Cover
--------------------------  -------  ------  --------
R/tm_a_pca.R                    -13     -13  +100.00%
R/tm_a_regression.R              -8      -8  +100.00%
R/tm_g_association.R            -17     -17  +100.00%
R/tm_g_bivariate.R              -12     -12  +0.66%
R/tm_g_distribution.R           -17     -17  +100.00%
R/tm_g_response.R               -14     -14  +100.00%
R/tm_g_scatterplot.R            -14     -14  +100.00%
R/tm_g_scatterplotmatrix.R      -14     -14  +0.32%
R/tm_missing_data.R             -24     -24  +100.00%
R/tm_outliers.R                 -23     -23  +100.00%
R/tm_t_crosstable.R             -16     -16  +100.00%
R/utils.R                        -9      -9  +0.67%
TOTAL                          -181    -181  +0.07%

Results for commit: 7c2dc13

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

github-actions · 2025-06-05T13:29:06Z

Unit Tests Summary

1 files 22 suites 2s ⏱️
144 tests 29 ✅ 115 💤 0 ❌
182 runs 67 ✅ 115 💤 0 ❌

Results for commit 7c2dc13.

♻️ This comment has been updated with latest results.

Companion to insightsengineering/teal.reporter#334 Consequence of changing naming convention for `teal_report` object. --------- Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

…l_data` (#255) # Pull Request Fixes: - insightsengineering/teal#1526 Built on top of: - insightsengineering/teal.reporter#307 - _(#307 will be closed once this PR is stable)_ ### Companion PRs: - insightsengineering/teal#1541 - #255 - insightsengineering/teal.data#370 - insightsengineering/teal.reporter#331 - insightsengineering/teal.modules.general#884 ### Changes description - [x] Add new parameter `cache` - Caches the result of the last evaluation in the respective `@code` slot - [ ] Decide on name - [x] Remove signature with multiple arguments to allow overriding `eval_code` in other packages without showing a note ``` r pkgload::load_all("teal.code") #> ℹ Loading teal.code q <- qenv() |> eval_code(1 + 1, cache = TRUE) |> eval_code(mtcars <- head(mtcars)) attr(q@code[[1]], "cache") #> [1] 2 ``` <sup>Created on 2025-06-03 with [reprex v2.1.1](https://reprex.tidyverse.org)</sup> --------- Co-authored-by: Dawid Kaledkowski <dawid.kaledkowski@gmail.com> Co-authored-by: Marcin <133694481+m7pr@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

…l_data` (#370) # Pull Request Fixes: - insightsengineering/teal#1526 Built on top of: - insightsengineering/teal.reporter#307 - _(#307 will be closed once this PR is stable)_ ### Companion PRs: - insightsengineering/teal#1541 - insightsengineering/teal.code#255 - #370 - insightsengineering/teal.reporter#331 - insightsengineering/teal.modules.general#884 ### Changes description - [x] Cleanup of `teal_data` class to allow for `teal_report` extension - [x] Change the `show()` method to remove reference to `teal_data` specifically --------- Co-authored-by: Dawid Kaledkowski <dawid.kaledkowski@gmail.com> Co-authored-by: Marcin <133694481+m7pr@users.noreply.github.com>

R/utils.R

# Pull Request - Changes from `teal_reportable` branch at `{ŧeal.report}` - Remove old logic that was defusing the argument

Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com>

R/utils.R

Merging this to a feature branch. The rest can be dona as normal issues. Thanks!

R/tm_outliers.R

Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com>

…g modules results

…ing/teal.modules.general into teal_reportable

R/tm_a_pca.R

Signed-off-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

R/tm_a_pca.R

Signed-off-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

R/tm_a_pca.R

Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com>

m7pr · 2025-07-08T09:29:29Z

There are R CMD CHECK warnings

https://github.com/insightsengineering/teal.modules.general/actions/runs/16136964888/job/45535248289#step:44:111

averissimo · 2025-07-10T13:31:10Z

R/tm_a_regression.R

@@ -982,7 +989,7 @@ srv_a_regression <- function(id,

    output_q <- reactive({
      teal::validate_inputs(iv_r())
-      switch(input$plot_type,
+      obj <- switch(input$plot_type,


Result will be the switch, why use obj?

Yeah, instead of

obj <- switch(input$plot_type, "Response vs Regressor" = output_plot_0(), "Residuals vs Fitted" = output_plot_1(), "Normal Q-Q" = output_plot_2(), "Scale-Location" = output_plot_3(), "Cook's distance" = output_plot_4(), "Residuals vs Leverage" = output_plot_5(), "Cook's dist vs Leverage" = output_plot_6() ) obj

we can go with

switch(input$plot_type, "Response vs Regressor" = output_plot_0(), "Residuals vs Fitted" = output_plot_1(), "Normal Q-Q" = output_plot_2(), "Scale-Location" = output_plot_3(), "Cook's distance" = output_plot_4(), "Residuals vs Leverage" = output_plot_5(), "Cook's dist vs Leverage" = output_plot_6() )

averissimo · 2025-07-10T13:31:42Z

R/tm_a_regression.R

    )

    fitted <- reactive({
-      req(output_q())
+      req(decorated_output_q())


❤️ good catch on both of these

averissimo · 2025-07-10T13:34:18Z

R/tm_a_pca.R

+          teal.reporter::teal_card(obj),
+          teal.reporter::teal_card("## Module's code")
+        )
+      teal.code::eval_code(obj, 'library("ggplot2");library("dplyr");library("tidyr")') # nolint: quotes.


What do you think about this change?

If you like it, I can find and replace all of these.

Suggested change

teal.code::eval_code(obj, 'library("ggplot2");library("dplyr");library("tidyr")') # nolint: quotes.

teal.code::eval_code(obj, expression(library("ggplot2"), library("dplyr"), library("tidyr"))

This is done in other modules

R/tm_g_association.R

R/tm_g_bivariate.R

averissimo · 2025-07-10T17:25:48Z

R/tm_g_scatterplotmatrix.R

@@ -370,7 +371,7 @@ srv_g_scatterplotmatrix <- function(id,

      # check character columns. If any, then those are converted to factors
      check_char <- vapply(ANL[, cols_names], is.character, logical(1))
-      qenv <- teal.code::eval_code(qenv, 'library("dplyr")') # nolint quotes
+      qenv <- teal.code::eval_code(qenv, 'library("dplyr")') # nolint: quotes.


Duplicate?

What is happening here so that the duplicate library call is present on Show R Code and not on reporter previewer?

it was on main. I didn't actually verify if this is needed. I think we could remove as it's already called earlier in this module

R/tm_missing_data.R

averissimo · 2025-07-10T17:32:14Z

R/tm_missing_data.R

        grid::grid.newpage()
        grid::grid.draw(combination_plot)
-      }
+        combination_plot


TableGrob appears that is not supported by to_rmd in teal.reporter @m7pr @gogonzo do you think we should add it?

Screenshot from report.html

averissimo · 2025-07-10T17:37:39Z

R/tm_outliers.R

@@ -906,6 +909,7 @@ srv_outliers <- function(id, data, reporter, filter_panel_api, outlier_var,
    # Cumulative distribution plot
    cumulative_plot_q <- reactive({
      qenv <- common_code_q()
+      teal.reporter::teal_card(qenv) <- c(teal.reporter::teal_card(qenv), "## Cumulative Distribution Plot")


Code and plot and not together, consider naming this section "## Cumulative Distribution Plot Code" and the actual plot the "## Cumulative Distribution Plot"

Same to summary table and the table

That or fully separate the 2 sections so that the code and prints are sequential

R/tm_t_crosstable.R

Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com> Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com>

R/tm_t_crosstable.R

Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com>

Signed-off-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

gogonzo added 5 commits May 20, 2025 11:58

wip

78d35c9

Merge branch 'teal_data_report' into teal_reportable

38ee62e

WIP implementation of teal_reportable

9c498c1

no need to grid.draw grobs

334509b

replace grob with grid output

61ab554

averissimo added the core label Jun 3, 2025

Merge remote-tracking branch 'origin/main' into teal_reportable

2d091a5

averissimo marked this pull request as ready for review June 5, 2025 13:11

[skip roxygen] [skip vbump] Roxygen Man Pages Auto Update

8162a8c

m7pr and others added 2 commits June 6, 2025 14:26

Naming (#885)

e734d5c

Companion to insightsengineering/teal.reporter#334 Consequence of changing naming convention for `teal_report` object. --------- Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

feat: improvements to tm_missing

f0600dc

m7pr reviewed Jun 13, 2025

View reviewed changes

R/utils.R Outdated Show resolved Hide resolved

averissimo and others added 2 commits June 17, 2025 14:42

feat: support argument rename and clean function body (#888)

ad5299c

# Pull Request - Changes from `teal_reportable` branch at `{ŧeal.report}` - Remove old logic that was defusing the argument

fix srv_decorate_teal_data expression check

c283343

Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com>

m7pr reviewed Jun 18, 2025

View reviewed changes

R/utils.R Outdated Show resolved Hide resolved

m7pr and others added 7 commits June 18, 2025 14:12

rewrite modules to teal_reportable (#887)

ba0e71e

Merging this to a feature branch. The rest can be dona as normal issues. Thanks!

use_evaluate WIP

38eb4a5

WIP on use_evaluate

c8f488a

Merge branch 'main' into use_evaluate

719fdaa

Merge branch 'use_evaluate' into teal_reportable

6ed5cbd

[skip roxygen] [skip vbump] Roxygen Man Pages Auto Update

3db8aaa

remotes

1384b90

change moment where datatable is created for tm_missing_data

630204b

m7pr reviewed Jul 2, 2025

View reviewed changes

R/tm_outliers.R Outdated Show resolved Hide resolved

m7pr and others added 4 commits July 2, 2025 13:43

Update R/tm_outliers.R

e3b5a0b

Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com>

do not reshape data into DT in tm_outliers - only do that for printin…

fdd9f89

…g modules results

Merge branch 'teal_reportable' of https://github.com/insightsengineer…

0f82001

…ing/teal.modules.general into teal_reportable

make Module's code section with two ## - so it's h2 instead of h1

9b324b0

averissimo commented Jul 7, 2025

View reviewed changes

R/tm_a_pca.R Outdated Show resolved Hide resolved

Update R/tm_a_pca.R

83e41a5

Signed-off-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

averissimo commented Jul 7, 2025

View reviewed changes

R/tm_a_pca.R Outdated Show resolved Hide resolved

averissimo and others added 2 commits July 7, 2025 15:06

Update R/tm_a_pca.R

229def2

Signed-off-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

[skip style] [skip vbump] Restyle files

6fc9beb

averissimo self-assigned this Jul 7, 2025

averissimo and others added 3 commits July 7, 2025 16:58

chore: fix long line

6d86ebc

[skip style] [skip vbump] Restyle files

508e3b2

chore: remove linter rule

3f82dca

averissimo commented Jul 7, 2025

View reviewed changes

R/tm_a_pca.R Outdated Show resolved Hide resolved

averissimo commented Jul 7, 2025

View reviewed changes

R/tm_a_pca.R Show resolved Hide resolved

Merge branch 'main' into teal_reportable

45b9080

Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com>

m7pr and others added 4 commits July 10, 2025 14:04

substitute append.teal_card with c.teal_card

52b4d59

[skip style] [skip vbump] Restyle files

162b917

chore: lintr using quotes rule with double column and period at the end

df02409

[skip style] [skip vbump] Restyle files

7c2dc13

averissimo commented Jul 10, 2025

View reviewed changes

m7pr and others added 2 commits July 11, 2025 14:35

Update R/tm_g_bivariate.R

85f15de

Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com> Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com>

Update R/tm_missing_data.R

5ad53e9

Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com> Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com>

m7pr reviewed Jul 11, 2025

View reviewed changes

R/tm_t_crosstable.R Outdated Show resolved Hide resolved

m7pr and others added 3 commits July 11, 2025 15:01

Update R/tm_t_crosstable.R

3bbf228

Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com>

missing assignment

b64c3d7

Update R/tm_g_association.R

16c525b

Signed-off-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

	teal.code::eval_code(obj, 'library("ggplot2");library("dplyr");library("tidyr")') # nolint: quotes.
	teal.code::eval_code(obj, expression(library("ggplot2"), library("dplyr"), library("tidyr"))

Uh oh!

{teal} module returns a teal_report object that extends from teal_data #884

Are you sure you want to change the base?

{teal} module returns a teal_report object that extends from teal_data #884

Conversation

averissimo commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

Companion PRs:

Changes description

Uh oh!

github-actions bot commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage Summary

Diff against main

Uh oh!

github-actions bot commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Tests Summary

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

m7pr commented Jul 8, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

`{teal}` module returns a `teal_report` object that extends from `teal_data` #884

`{teal}` module returns a `teal_report` object that extends from `teal_data` #884

averissimo commented Jun 3, 2025 •

edited

Loading

github-actions bot commented Jun 5, 2025 •

edited

Loading

github-actions bot commented Jun 5, 2025 •

edited

Loading