Add tables to `show-r-code` in distribution, scatterplot and outliers modules #574

averissimo · 2023-08-11T12:01:31Z

Pull Request

Fixes #558

Changes description

Adds tables to Show R code shown on screen for different modules

tm_g_distribution: simple "print" of existing table to qenv
tm_g_scatterplot.R: simple "print" of existing table to qenv
tm_outliers.R
- Complex change that adds an extended data frame enriched with additional columns shown in table
  - Solution doesn't keep repetitive code
  - Keeps previous workflow as much as it can
- Possible alternative solution (easier)
  - This would just print the ANL_OUTLIERS that only has 6 columns

How to test

Run locally the exploratory application of teal.gallery
Open the modules and test the module while observing/running the Show R code
Brush selection to see if previous behaviour is kept
- Filters the table, but not the code
- Adding selected columns in Outliers table won't deselect the data points selection

github-actions · 2023-08-11T12:08:22Z

Code Coverage Summary

Filename                      Stmts    Miss  Cover    Missing
--------------------------  -------  ------  -------  ----------------------------------------------
R/tm_a_pca.R                    828     828  0.00%    72-1024
R/tm_a_regression.R             714     714  0.00%    92-889
R/tm_data_table.R               171     171  0.00%    58-281
R/tm_file_viewer.R              172     172  0.00%    39-241
R/tm_front_page.R               127     116  8.66%    63-205
R/tm_g_association.R            331     331  0.00%    89-478
R/tm_g_bivariate.R              653     493  24.50%   124-703, 751, 757, 761, 872, 889, 907, 927-949
R/tm_g_distribution.R          1026    1026  0.00%    110-1258
R/tm_g_response.R               347     347  0.00%    85-496
R/tm_g_scatterplot.R            717     717  0.00%    160-968
R/tm_g_scatterplotmatrix.R      278     259  6.83%    78-373, 427, 441
R/tm_missing_data.R            1039    1039  0.00%    58-1234
R/tm_outliers.R                 974     974  0.00%    76-1180
R/tm_t_crosstable.R             252     252  0.00%    81-371
R/tm_variable_browser.R         822     817  0.61%    61-1311
R/utils.R                       122     122  0.00%    74-351
R/zzz.R                           1       1  0.00%    2
TOTAL                          8574    8379  2.27%

Diff against main

Filename                 Stmts    Miss  Cover
---------------------  -------  ------  --------
R/tm_g_distribution.R       +1      +1  +100.00%
R/tm_g_scatterplot.R        +1      +1  +100.00%
R/tm_outliers.R            +32     +32  +100.00%
TOTAL                      +34     +34  -0.01%

Results for commit: 72ba9c9

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

github-actions · 2023-08-11T12:10:14Z

Unit Tests Summary

  1 files   5 suites 0s ⏱️
16 tests 16 ✔️ 0 💤 0 ❌
49 runs 49 ✔️ 0 💤 0 ❌

Results for commit e580250.

♻️ This comment has been updated with latest results.

kartikeyakirar · 2023-08-14T10:08:04Z

Hi @averissimo, just wanted to let you know that you can find useful tips on naming conventions for stage dependencies at this link: GitHub Naming Conventions. When you use a branch name like "print_tables_show_r_code@main," the staged.dependencies tool will check branches in other repositories.

R/tm_g_distribution.R

kartikeyakirar · 2023-08-14T13:11:03Z

R/tm_outliers.R

+        )
+      ) %>%
+        # used to display table when running show-r-code code
+        teal.code::eval_code(quote(ANL_OUTLIER_EXTENDED[ANL_OUTLIER_EXTENDED$is_outlier_selected, ]))


ANL_OUTLIER_EXTENDED[ANL_OUTLIER_EXTENDED$is_outlier_selected, ]Show all columns in the dataset, including those not displayed on the dashboard.

I believe that the code should print a table that displays on the dashboard, as well as any user-selected columns.

@kartikeyakirar this may have a UX side effect as any change to the columns being selected will clear the selected data points.

My suggestion is to add the outlier table print after the plot call, otherwise, any column change will trigger reactivity in the <plot>_q and re-render the plot.

The downside is that this approach requires duplicate code only (column selection)

WDYT?

Show all columns in the dataset, including those not displayed on the dashboard.

this problem is fixed. I can see table displayed on dashboard.

any change to the columns being selected will clear the selected data points.

I believe there's no necessity for us to proceed with this step, as we're unable print user selections within the ggplot. Thus, there's no need to gather the selected datapoints in reproducible code. In my opinion, doing so might lead to confusion when working with reproducible code. I'd appreciate your input on this, @cicdguy, particularly with regard to displaying datapoints from outlier selections in the plot.

Image to capture outlier points on table

I'll defer to @donyunardi or @gogonzo to voice their opinions on this. I don't think I'm qualified to speak to this 👨🏽‍🎓

@kartikeyakirar

any change to the columns being selected will clear the selected data points.

My statement wasn't super clear. This relates to the placement of the table-print code in qenv, as if we place the code for table-print before the plot-print, then it will add reactivity that re-renders the plot every time a column is selected/deselected (which causes all brushed selection being lost)

Hence, the table-print is located after the plot-print.

Hence, the table-print is located after the plot-print.

The solution is looking good! Just wanted to mention that the placement of the table code seems alright in my opinion.

kartikeyakirar · 2023-08-17T11:55:29Z

@averissimo can you make similar change to your PR to Pass GitHub checks. d711d17

kartikeyakirar · 2023-08-22T08:10:34Z

I believe there's no necessity for us to proceed with this step, as we're unable print user selections within the ggplot. Thus, there's no need to gather the selected datapoints in reproducible code. In my opinion, doing so might lead to confusion when working with reproducible code. I'd appreciate your input on this, @cicdguy, particularly with regard to displaying datapoints from outlier selections in the plot.

Hey @averissimo, I still have some concerns about this point. Could we add another task for discussion regarding this matter?

averissimo added bug Something isn't working core labels Aug 11, 2023

kartikeyakirar reviewed Aug 14, 2023

View reviewed changes

R/tm_g_distribution.R Outdated Show resolved Hide resolved

kartikeyakirar reviewed Aug 14, 2023

View reviewed changes

averissimo force-pushed the print_tables_show_r_code branch from 20d4472 to 43ad79b Compare August 16, 2023 07:07

averissimo and others added 7 commits August 18, 2023 12:18

fix: add table to distribution module in show-r-code

cdefd9f

fix: add table to outlier module in show-r-code

985a212

fix: add table to scatterplot module in show-r-code

9089126

chore: correct linter error

a4e573d

[skip actions] Restyle files

8afbd41

chore: feedback from review to move print code

df6e127

fix: only print columns that are shown in UI (show-r-code)

77be5b3

averissimo force-pushed the print_tables_show_r_code branch from d540cf1 to 77be5b3 Compare August 18, 2023 10:18

Merge branch 'main' into print_tables_show_r_code

e580250

kartikeyakirar approved these changes Aug 22, 2023

View reviewed changes

averissimo merged commit 992b3de into main Aug 23, 2023

averissimo deleted the print_tables_show_r_code branch August 23, 2023 11:07

donyunardi mentioned this pull request Sep 13, 2024

[Bug]: tm_outliers can not create a report card / Error : Can't subset columns that don't exist. ✖ Column order doesn't exist. #768

Closed

Uh oh!

Add tables to show-r-code in distribution, scatterplot and outliers modules #574

Add tables to show-r-code in distribution, scatterplot and outliers modules #574

Uh oh!

Conversation

averissimo commented Aug 11, 2023

Pull Request

Changes description

How to test

Uh oh!

github-actions bot commented Aug 11, 2023 • 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 Aug 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Tests Summary

Uh oh!

kartikeyakirar commented Aug 14, 2023

Uh oh!

Uh oh!

kartikeyakirar Aug 14, 2023

Choose a reason for hiding this comment

Uh oh!

averissimo Aug 16, 2023

Choose a reason for hiding this comment

Uh oh!

kartikeyakirar Aug 17, 2023

Choose a reason for hiding this comment

Uh oh!

kartikeyakirar Aug 17, 2023

Choose a reason for hiding this comment

Uh oh!

cicdguy Aug 17, 2023

Choose a reason for hiding this comment

Uh oh!

averissimo Aug 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kartikeyakirar Aug 22, 2023

Choose a reason for hiding this comment

Uh oh!

kartikeyakirar commented Aug 17, 2023

Uh oh!

kartikeyakirar commented Aug 22, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add tables to `show-r-code` in distribution, scatterplot and outliers modules #574

Add tables to `show-r-code` in distribution, scatterplot and outliers modules #574

github-actions bot commented Aug 11, 2023 •

edited

Loading

github-actions bot commented Aug 11, 2023 •

edited

Loading

averissimo Aug 18, 2023 •

edited

Loading