update vignette on making custom teal module

[donyunardi]

Fixes #1356

Update vignette for step-by-step guide to creating a custom teal module.

[donyunardi]

Hi @kumamiao
In addition to the coredev review, please also review this to ensure it is clear and easy for you to follow and understand.

[github-actions]

Unit Tests Summary

  1 files   25 suites   9m 49s ⏱️
265 tests 261 ✅ 4 💤 0 ❌
520 runs  516 ✅ 4 💤 0 ❌

Results for commit 3b0deb7.

♻️ 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	💔	$70.89$	$+6.05$	$0$	$0$	$0$	$0$
shinytest2-data_summary	💔	$51.34$	$+7.08$	$0$	$0$	$0$	$0$
shinytest2-filter_panel	💔	$42.68$	$+5.47$	$0$	$0$	$0$	$0$
shinytest2-init	💔	$28.40$	$+1.48$	$0$	$0$	$0$	$0$
shinytest2-landing_popup	💔	$47.45$	$+3.98$	$0$	$0$	$0$	$0$
shinytest2-module_bookmark_manager	💔	$37.47$	$+5.51$	$0$	$0$	$0$	$0$
shinytest2-modules	💔	$39.87$	$+6.53$	$0$	$0$	$0$	$0$
shinytest2-reporter	💔	$67.89$	$+5.55$	$0$	$0$	$0$	$0$
shinytest2-teal_data_module	💔	$49.21$	$+1.67$	$0$	$0$	$0$	$0$
shinytest2-teal_slices	💔	$61.55$	$+2.30$	$0$	$0$	$0$	$0$
shinytest2-wunder_bar	💔	$21.97$	$+1.41$	$0$	$0$	$0$	$0$

Additional test case details

Test Suite	$Status$	Time on main	$±Time$	Test Case
module_teal	💔	$1.67$	$+1.72$	clicking_reset_button_restores_initial_filters_with_respect_to_mapping_state_when_module_specific
module_teal	💚	$18.58$	$-1.36$	creation_process_is_invoked_for_teal.lockfile.mode_enabled_and_snapshot_is_copied_to_teal_app.lock_and_removed_after_session_ended
shinytest2-data_summary	💔	$8.54$	$+1.42$	e2e_data_summary_just_list_the_unfilterable_objects_at_the_bottom_when_provided
shinytest2-data_summary	💔	$8.44$	$+1.64$	e2e_data_summary_table_displays_datasets_by_names_order_if_no_join_keys
shinytest2-data_summary	💔	$8.10$	$+1.36$	e2e_data_summary_table_displays_datasets_by_topological_sort_of_join_keys
shinytest2-data_summary	💔	$9.82$	$+1.29$	e2e_data_summary_table_does_not_list_unsupported_objects
shinytest2-data_summary	💔	$8.44$	$+1.22$	e2e_data_summary_table_is_displayed_with_3_columns_for_data_with_join_keys
shinytest2-filter_panel	💔	$16.24$	$+1.62$	e2e_filtering_a_module_specific_filter_is_not_refected_in_other_unshared_modules
shinytest2-filter_panel	💔	$15.90$	$+2.92$	e2e_filtering_a_module_specific_filter_is_reflected_in_other_shared_module
shinytest2-init	💔	$11.08$	$+1.02$	e2e_teal_app_initializes_with_sessionInfo_modal
shinytest2-landing_popup	💔	$8.89$	$+1.47$	e2e_teal_app_with_landing_popup_module_initializes_with_no_errors
shinytest2-module_bookmark_manager	💔	$8.73$	$+1.45$	bookmark_manager_button_is_not_rendered_by_default
shinytest2-module_bookmark_manager	💔	$8.78$	$+1.46$	bookmark_manager_button_is_not_rendered_when_enableBookmarking_url_
shinytest2-module_bookmark_manager	💔	$8.82$	$+1.33$	bookmark_manager_button_is_rendered_when_enableBookmarking_server_
shinytest2-module_bookmark_manager	💔	$11.13$	$+1.26$	bookmark_manager_button_shows_modal_with_url_containing_state_id_when_clicked
shinytest2-modules	💔	$8.74$	$+2.34$	e2e_all_the_nested_teal_modules_are_initiated_as_expected
shinytest2-modules	💔	$10.57$	$+1.92$	e2e_filter_panel_only_shows_the_data_supplied_using_datanames
shinytest2-modules	💔	$9.74$	$+1.44$	e2e_the_module_server_logic_is_only_triggered_when_the_teal_module_becomes_active
shinytest2-reporter	💔	$18.46$	$+1.28$	e2e_adding_a_report_card_in_a_module_adds_it_in_the_report_previewer_tab
shinytest2-reporter	💔	$18.92$	$+1.34$	e2e_reporter_does_not_show_the_secondary_column_that_shows_filter_panel
shinytest2-reporter	💔	$13.27$	$+1.33$	e2e_reporter_previewer_module_do_not_show_data_summary_nor_filter_panel
shinytest2-reporter	💔	$8.61$	$+1.36$	e2e_reporter_tab_is_not_created_when_a_module_has_no_reporter
shinytest2-teal_data_module	💔	$9.46$	$+1.36$	e2e_teal_data_module_will_have_a_delayed_load_of_datasets
shinytest2-teal_slices	💔	$23.78$	$+1.16$	e2e_teal_slices_filters_are_initialized_when_global_filters_are_created
shinytest2-teal_slices	💔	$37.77$	$+1.14$	e2e_teal_slices_filters_are_initialized_when_module_specific_filters_are_created
shinytest2-wunder_bar	💔	$11.25$	$+1.16$	wunder_bar_srv_clicking_filter_icon_opens_filter_manager_modal

Results for commit 3482aa1

♻️ This comment has been updated with latest results.

[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             203      38  81.28%   26-54, 78, 219, 224, 238, 269-273
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              236      91  61.44%   40-142, 174, 199-201, 320, 360
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                149      10  93.29%   41-48, 84, 135-136
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, 217
R/module_transform_data.R            54      32  40.74%   17-52
R/modules.R                         280      72  74.29%   173-177, 232-235, 356-376, 384, 534-540, 553-562, 578-626, 659, 671-679
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                 58       0  100.00%
R/teal_data_utils.R                  31       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                           225      37  83.56%   378-426
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                              3255    1305  59.91%

Diff against main

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

Results for commit: 3b0deb7

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[kumamiao]

I think it looks great! One comment re: the flow, the table of contents at the front helps understand the overall flow of this guide, but when user gets to the actual module customizations part, one may get lost of which step I'm at. I wonder if it would be more helpful to pin it as a navigation bar on the left, just like the bookdown manual.

[donyunardi]

@kumamiao

One comment re: the flow, the table of contents at the front helps understand the overall flow of this guide, but when user gets to the actual module customizations part, one may get lost of which step I'm at. I wonder if it would be more helpful to pin it as a navigation bar on the left, just like the bookdown manual.

It looks like you may have just knitted the .Rmd file instead of running pkgdown::build_site(). Can you confirm?
The current setup places navigation on the right side, which remains visible as the user scrolls down.

I think this is sufficient for users to navigate through the steps, but let me know what you think.

[averissimo]

Very nice improvement on the vignette!

I have some minor comments

[averissimo]

The vignette looks good to me and it will be a great guide for those wanting to create custom modules

There are still open comments, I'll be around until later to approve once those are resolved.