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

Update the options vignette #1092

Merged
merged 1 commit into from
Feb 7, 2024
Merged

Update the options vignette #1092

merged 1 commit into from
Feb 7, 2024

Conversation

vedhav
Copy link
Contributor

@vedhav vedhav commented Feb 7, 2024

Closes #1066

Changes:

  1. Verified the current options we support.
    • ✅ teal (teal.load_nest_code, teal.show_js_log, teal.bs_theme)
    • ✅ teal.logger (teal.log_level)
    • ✅ teal.widgets (teal.basic_table_args, teal.ggplot2_args, teal.plot_dpi)
    • ✅ teal.slice (teal.threshold_slider_vs_checkboxgroup)
    • ❌ teal.modules.general (ggplot2.discrete.colour)
    • ❌ teal.modules.clinical (ggplot2.discrete.colour, tmc_default_total_label)
  2. Removed the context of where the options were implemented, it seems unnecessary.
  3. Reordered the options in the way that important and most used are at the top and are grouped when possible. And, moved the depreciated options to the bottom.

@vedhav vedhav added documentation Improvements or additions to documentation core labels Feb 7, 2024
Copy link
Contributor

github-actions bot commented Feb 7, 2024

badge

Code Coverage Summary

Filename                          Stmts    Miss  Cover    Missing
------------------------------  -------  ------  -------  -------------------------------------------------------------------------------------------------------------------------------
R/dummy_functions.R                  30      21  30.00%   21-33, 36-43
R/get_rcode_utils.R                  32       1  96.88%   51
R/include_css_js.R                   22       0  100.00%
R/init.R                             86      31  63.95%   107-114, 160-161, 163, 175-196, 226-227, 229
R/landing_popup_module.R             25      25  0.00%    61-87
R/module_filter_manager.R           107      36  66.36%   79-85, 92-100, 109-114, 237, 242-255
R/module_nested_tabs.R              154      58  62.34%   102-175, 191, 243, 265, 291
R/module_snapshot_manager.R         209     157  24.88%   87-99, 127-136, 140-152, 154-161, 168-182, 186-188, 190-195, 198-208, 211-227, 236-251, 265-288, 291-302, 305-311, 325, 343-366
R/module_tabs_with_filters.R         76      33  56.58%   92-127, 159, 175
R/module_teal_with_splash.R         114       4  96.49%   110, 131, 197-198
R/module_teal.R                     139      32  76.98%   81, 92, 101, 174-175, 181, 212, 220-221, 243-274
R/modules.R                         153      27  82.35%   120-123, 140-144, 199-203, 285-286, 338, 350-358, 438-441
R/reporter_previewer_module.R        18       2  88.89%   30, 34
R/show_rcode_modal.R                 19      19  0.00%    17-36
R/tdata.R                            53       1  98.11%   154
R/teal_data_module-eval_code.R       27       0  100.00%
R/teal_data_module-within.R           7       0  100.00%
R/teal_data_module.R                  6       0  100.00%
R/teal_reporter.R                    60       5  91.67%   65, 114-115, 118, 135
R/teal_slices-store.R                29       0  100.00%
R/teal_slices.R                      59      12  79.66%   137-150
R/utils.R                           147      27  81.63%   117-144
R/validate_inputs.R                  32       0  100.00%
R/validations.R                      58      37  36.21%   110-377
R/zzz.R                              11       7  36.36%   3-14
TOTAL                              1673     535  68.02%

Diff against main

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

Results for commit: 850122a

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Contributor

github-actions bot commented Feb 7, 2024

Unit Tests Summary

  1 files   19 suites   10s ⏱️
207 tests 207 ✅ 0 💤 0 ❌
418 runs  418 ✅ 0 💤 0 ❌

Results for commit 850122a.

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.

👍 looks good.
I would only think that teal.log_level is the most popular option... but probably for a teal core dev team member and not the app developer :)

@vedhav
Copy link
Contributor Author

vedhav commented Feb 7, 2024

I would only think that teal.log_level is the most popular option... but probably for a teal core dev team member and not the app developer :)

Yeah, I had to prioritize app developer > module developer > framework developer.

@vedhav vedhav merged commit a089b23 into main Feb 7, 2024
23 checks passed
@vedhav vedhav deleted the 1066-update-options-vignette branch February 7, 2024 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Investigate the exhaustiveness of the documentation about options in our vignettes
2 participants