[DO-NOT-MERGE] Create how-to guide to migrate from old "Show R Code"/"Reporter

[averissimo]

Pull Request

• Fixes [Documentation]: Create how-to guide to migrate from old "Show R Code"/"Reporter" #1609

Do not merge

This document will be moved to Discussion section, this is here purely for review

[averissimo]

Placing an unresolved comment here to block any accidental merge

[github-actions]

Code Coverage Summary

Filename                          Stmts    Miss  Cover    Missing
------------------------------  -------  ------  -------  --------------------------------------------------------------------------------------------------------------------------------------
R/after.R                            59      21  64.41%   42-52, 64, 69, 77-79, 81-89, 100, 104-105
R/checkmate.R                        24       0  100.00%
R/dummy_functions.R                  61       2  96.72%   44, 46
R/include_css_js.R                   11       0  100.00%
R/init.R                            152       1  99.34%   299
R/landing_popup_module.R             34      10  70.59%   44-53
R/module_bookmark_manager.R         153     117  23.53%   54-58, 78-133, 138-139, 151, 198, 233-310
R/module_data_summary.R             177       8  95.48%   40, 50, 205, 236-240
R/module_filter_data.R               64       0  100.00%
R/module_filter_manager.R           229      50  78.17%   72-81, 89-94, 107-111, 116-117, 290-313, 339, 366, 378, 385-386
R/module_init_data.R                 84       6  92.86%   38-43
R/module_nested_tabs.R              371      37  90.03%   163, 267-282, 302-306, 324, 361, 479-482, 486-489, 493-496, 541
R/module_session_info.R              18       0  100.00%
R/module_snapshot_manager.R         271     194  28.41%   103-112, 120-144, 163-164, 181-210, 214-229, 231-238, 245-275, 279, 283-287, 289-295, 298-311, 314-322, 352-366, 369-380, 383-397, 410
R/module_source_code.R               69       0  100.00%
R/module_teal_data.R                149      76  48.99%   43-149
R/module_teal_lockfile.R            131      53  59.54%   45-57, 60-62, 76, 86-88, 100-102, 110-119, 122, 124, 126-127, 142-146, 161-162, 177-186
R/module_teal_reporter.R            122       9  92.62%   60, 77-78, 81, 98, 128, 142, 144, 158
R/module_teal_with_splash.R          33      33  0.00%    24-61
R/module_teal.R                     213      28  86.85%   130, 134-135, 145-146, 186, 204-220, 222, 255-256, 263-264
R/module_transform_data.R           116       6  94.83%   46, 130-134
R/modules.R                         291      51  82.47%   170-174, 229-232, 356-376, 384, 390, 567-573, 586-594, 609-624
R/reporter_previewer_module.R        41      41  0.00%    22-85
R/show_rcode_modal.R                 31      31  0.00%    17-49
R/tdata.R                            14      14  0.00%    19-61
R/teal_data_module-eval_code.R       23       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                  49       0  100.00%
R/teal_modifiers.R                   57       0  100.00%
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                   297     297  0.00%    50-620
R/utils.R                           291      48  83.51%   402-451, 539-548
R/validate_inputs.R                  32       0  100.00%
R/validations.R                      58      37  36.21%   114-392
R/zzz.R                              19      15  21.05%   4-22
TOTAL                              3908    1185  69.68%

Diff against main

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

Results for commit: 34ab490

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

  1 files   29 suites   2m 36s ⏱️
331 tests 265 ✅ 66 💤 0 ❌
533 runs  467 ✅ 66 💤 0 ❌

Results for commit 34ab490.

♻️ 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$
module_teal	💔	$119.22$	$+4.99$	$0$	$0$	$0$	$0$

Results for commit 4724f2b

♻️ This comment has been updated with latest results.

[Copilot]

Pull Request Overview

This PR introduces a migration guide for teal v1.1.0, documenting changes to the module system that introduce a new teal_reporter object, simplify reporting interfaces, and automate code reproducibility features. The guide helps module developers transition from the deprecated "Show R Code"/Reporter implementation to the new unified system.

Key Changes:

• Documents the introduction of teal_reporter object and teal_card class for managing reports
• Provides step-by-step migration instructions for updating existing modules
• Includes concrete code examples from the tm_a_regression module showing before/after changes

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[llrs-roche]

Looks good, just two comments, one about teal_card (I don't mention teal_reporter as I think it is clearly explained that it is automatic, but that doesn't happen for teal_card), and one about the summary at the end.

The examples are great and it shows how much of an improvement this feature is.

[llrs-roche]

I approve this because I think it is short, to the point and helpful. But I am sure other people on the team will have good suggestions too. I would also ask around to check this document.

[m7pr]

Hey @averissimo , in general amazing job : ) just left few small comments

[averissimo]

After talking with @m7pr , we'll create the discussion issue right now and close the PR & issue

Discussion link: #1643