Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the definition of "transform" in the vignettes #1489

Merged
merged 10 commits into from
Feb 12, 2025
Merged

Conversation

vedhav
Copy link
Contributor

@vedhav vedhav commented Feb 12, 2025

Closes #1475

Customizing Module Output vignette is now called Transform Module Output
As we introduce a new term "customize" and it would be best to use the same term "transform" that we se to transform the teal_data object

Data Transformations as Shiny Module is now called Transform Input Data
This name was appropriate at the time of writing the vignette when transformation done using shiny module was only possible in one place, now that is not the case and we have two places where data is transformed using shiny module. And from the user's perspective the main thing showcased in this vignette is about transforming the input data.

@vedhav vedhav added documentation Improvements or additions to documentation core labels Feb 12, 2025
Copy link
Contributor

github-actions bot commented Feb 12, 2025

badge

Code Coverage Summary

Filename                          Stmts    Miss  Cover    Missing
------------------------------  -------  ------  -------  ----------------------------------------------------------------------------------------------------------------------------------------
R/checkmate.R                        24       0  100.00%
R/dummy_functions.R                  67      11  83.58%   46, 48, 90-98
R/include_css_js.R                   22      17  22.73%   12-38, 76-82
R/init.R                            142      96  32.39%   141-162, 192-200, 210-235, 238-239, 246-255, 258-267, 270-279, 283-293, 295
R/landing_popup_module.R             34      34  0.00%    22-57
R/module_bookmark_manager.R         158     127  19.62%   47-68, 88-138, 143-144, 156, 203, 238-315
R/module_data_summary.R             203      37  81.77%   25-53, 67, 77, 231, 262-266
R/module_filter_data.R               64       2  96.88%   22-23
R/module_filter_manager.R           230      57  75.22%   56-62, 73-82, 90-95, 108-112, 117-118, 291-314, 340, 367, 379, 386-387
R/module_init_data.R                 74       0  100.00%
R/module_nested_tabs.R              227      84  63.00%   40-136, 168, 193-195, 346
R/module_session_info.R              18       7  61.11%   35-41
R/module_snapshot_manager.R         216     146  32.41%   89-95, 104-113, 121-133, 152-153, 170-180, 184-199, 201-208, 215-230, 234-238, 240-246, 249-262, 265-273, 303-317, 320-331, 334-340, 354
R/module_teal_data.R                149      76  48.99%   43-149
R/module_teal_lockfile.R            131      55  58.02%   33-37, 45-57, 60-62, 76, 86-88, 92-96, 100-102, 110-119, 122, 124, 126-127, 161-162, 196-201
R/module_teal_with_splash.R          33      33  0.00%    24-61
R/module_teal.R                     158      56  64.56%   50-107, 124, 138-139, 178
R/module_transform_data.R           126       7  94.44%   20, 59, 142-146
R/modules.R                         285      53  81.40%   174-178, 233-236, 360-380, 388, 394, 571-577, 590-598, 613-628, 674, 687
R/reporter_previewer_module.R        19       1  94.74%   34
R/show_rcode_modal.R                 24      24  0.00%    17-42
R/tdata.R                            14      14  0.00%    19-61
R/teal_data_module-eval_code.R       24       0  100.00%
R/teal_data_module-within.R           7       0  100.00%
R/teal_data_module.R                 20       0  100.00%
R/teal_data_utils.R                  10       0  100.00%
R/teal_modifiers.R                   71      71  0.00%    26-214
R/teal_reporter.R                    70       8  88.57%   69, 77-82, 131-132, 135, 152
R/teal_slices-store.R                29       0  100.00%
R/teal_slices.R                      63       0  100.00%
R/teal_transform_module.R            45       0  100.00%
R/TealAppDriver.R                   376     376  0.00%    56-765
R/utils.R                           250      38  84.80%   400-449
R/validate_inputs.R                  32       0  100.00%
R/validations.R                      58      37  36.21%   118-406
R/zzz.R                              15      11  26.67%   4-18
TOTAL                              3488    1478  57.63%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: c1314dc

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Contributor

github-actions bot commented Feb 12, 2025

Unit Tests Summary

  1 files   27 suites   10m 49s ⏱️
274 tests 270 ✅ 4 💤 0 ❌
534 runs  530 ✅ 4 💤 0 ❌

Results for commit c1314dc.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Feb 12, 2025

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
module_teal 💔 $130.74$ $+2.61$ $0$ $0$ $0$ $0$
shinytest2-data_summary 💔 $50.10$ $+1.74$ $0$ $0$ $0$ $0$
shinytest2-filter_panel 💔 $41.42$ $+1.30$ $0$ $0$ $0$ $0$
shinytest2-landing_popup 💔 $45.12$ $+3.33$ $0$ $0$ $0$ $0$
shinytest2-module_bookmark_manager 💔 $36.10$ $+1.70$ $0$ $0$ $0$ $0$
shinytest2-modules 💔 $38.72$ $+1.65$ $0$ $0$ $0$ $0$
shinytest2-reporter 💔 $66.56$ $+1.18$ $0$ $0$ $0$ $0$
shinytest2-teal_data_module 💔 $46.90$ $+2.29$ $0$ $0$ $0$ $0$

Results for commit 02e5df3

♻️ This comment has been updated with latest results.

@m7pr
Copy link
Contributor

m7pr commented Feb 12, 2025

Hey @vedhav I think it is solid.
I only changed usage of transformer to transformator, as we once agreed on naming: tranformators + decorators. Transformators is the name also used in other places of the documentaiton.

The name of the vignette changed, and this changed also needs to be reflected in tmc and in tmg, where those packages link to teal vignette. I can handle that.

Copy link
Contributor

@m7pr m7pr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @vedhav I think this is solid. Left 2-3 minor comments, but this is good to go

@vedhav vedhav enabled auto-merge (squash) February 12, 2025 13:12
@vedhav vedhav merged commit 5aef4d7 into main Feb 12, 2025
28 checks passed
@vedhav vedhav deleted the 1475_vignettes@main branch February 12, 2025 13:31
@github-actions github-actions bot locked and limited conversation to collaborators Feb 12, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
core documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Funciton naming around decorators
3 participants