1303 add a note to teal_data_module constructor's vignette

[m7pr]

As discussed, the note would be helpful in the teal_data_module constructor's vignette #1303
@donyunardi assigning you for the review as you said yesterday you might have a look at this one.

[github-actions]

Code Coverage Summary

Filename                          Stmts    Miss  Cover    Missing
------------------------------  -------  ------  -------  ----------------------------------------------------------------------------------------------------------------------------------------
R/checkmate.R                        24       0  100.00%
R/dummy_functions.R                  47      11  76.60%   27, 29, 41, 52-59
R/get_rcode_utils.R                  12       0  100.00%
R/include_css_js.R                   22      17  22.73%   12-38, 76-82
R/init.R                            108      50  53.70%   107-114, 160-169, 171, 183-204, 229-232, 239-245, 248-249, 251
R/landing_popup_module.R             25      25  0.00%    61-87
R/module_bookmark_manager.R         158     127  19.62%   47-68, 88-138, 143-144, 156, 203, 238-315
R/module_data_summary.R             189      68  64.02%   24-52, 93, 187, 227-267
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                 68       0  100.00%
R/module_nested_tabs.R              220      93  57.73%   40-144, 176, 201-203, 317, 356
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, 304-318, 321-332, 335-341, 355
R/module_teal_data.R                152      11  92.76%   41-48, 84, 135-136, 174
R/module_teal_lockfile.R            131      44  66.41%   32-36, 44-56, 59-61, 75, 85-87, 99-101, 109-118, 121, 123, 125-126, 160-161
R/module_teal_with_splash.R          12      12  0.00%    22-38
R/module_teal.R                     190      87  54.21%   48-143, 158, 184-185, 216
R/module_transform_data.R            56      32  42.86%   17-51
R/modules.R                         181      32  82.32%   166-170, 225-228, 326-327, 359-373, 411, 423-431
R/reporter_previewer_module.R        19       2  89.47%   30, 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                 43       0  100.00%
R/teal_data_utils.R                  32       0  100.00%
R/teal_reporter.R                    68       6  91.18%   69, 77, 125-126, 129, 146
R/teal_slices-store.R                29       0  100.00%
R/teal_slices.R                      63       0  100.00%
R/TealAppDriver.R                   353     353  0.00%    52-735
R/utils.R                           203       0  100.00%
R/validate_inputs.R                  32       0  100.00%
R/validations.R                      58      37  36.21%   110-377
R/zzz.R                              15      11  26.67%   4-18
TOTAL                              3089    1261  59.18%

Diff against main

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

Results for commit: 4a6bbb1

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

  1 files   25 suites   8m 46s ⏱️
253 tests 249 ✅ 4 💤 0 ❌
508 runs  504 ✅ 4 💤 0 ❌

Results for commit 4a6bbb1.

♻️ This comment has been updated with latest results.

[github-actions]

Unit Test Performance Difference

Test Suite	$Status$	Time on main	$±Time$	$±Tests$	$±Skipped$	$±Failures$	$±Errors$
shinytest2-init	💔	$28.61$	$+1.02$	$0$	$0$	$0$	$0$
shinytest2-modules	💔	$40.00$	$+1.21$	$0$	$0$	$0$	$0$
shinytest2-reporter	💔	$68.91$	$+1.40$	$0$	$0$	$0$	$0$
shinytest2-teal_data_module	💔	$47.43$	$+1.21$	$0$	$0$	$0$	$0$
shinytest2-teal_slices	💔	$60.85$	$+1.20$	$0$	$0$	$0$	$0$

Results for commit e217083

♻️ This comment has been updated with latest results.

[donyunardi]

I understand that teal_transform_module is an instance of teal_data_module, which is probably why we use the term teal_data_module here. However, since the conversations leading up to this PR have been more focused on teal_transform_module, it would be better to keep these terms separate. teal_data_module should refer to defining delayed data, while teal_transform_module is for transforming data within the module.

Additionally, I think it would be better to include this information in the data-transform-as-shiny-module.Rmd vignette, as it relates more directly to the transformation process.

We should also make it clear on what user need to do if they choose to use eventReactive. I'm fine with directing user to the discussion link, but we should summarize it clearly for users too.

[m7pr]

Hey, I have

• moved the note from data-as-shiny-module.Rmd to data-transform-as-shiny-module.Rmd
• changed the name from teal_data_module into teal_transform_module
• specify that eventReactive needs to be reactive on data() in the server part

[donyunardi]

At first, I thought we should show some code if users were to use eventReactive. But after thinking it over, if we're discouraging users from doing this, maybe it's best not to mention it at all.

LGTM!

[gogonzo]

Issue might be outdated when #1330 goes in

[gogonzo]

I don't think this is a good way. Please see the comment:

#1303 (comment)

[m7pr]

I think we should revisit, once we are done with #1341

[donyunardi]

@gogonzo @m7pr can you please assess if we still need this PR?
If not, please close.

[gogonzo]

@gogonzo @m7pr can you please assess if we still need this PR? If not, please close.

I raised my opinion in the issue, I think more effort on the teal's reactivity is needed before giving up and writing a comment in a vignette.

[averissimo]

I merged this manually on #1373

Thankis @m7pr !