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

818 documentation cleanup #869

Merged
merged 26 commits into from
Jul 28, 2023
Merged

818 documentation cleanup #869

merged 26 commits into from
Jul 28, 2023

Conversation

m7pr
Copy link
Contributor

@m7pr m7pr commented Jul 21, 2023

Closes #818

With this PR we aimed to explain teal.code usage in Adding support for Reporting to custom modules vignette. This vignette demonstrates the usage of teal.reporter modules with teal apps. The example with teal.code is not necessary for the vignette however it shows an advanced combination of usage of teal.code and teal.reporter hence I decided not to remove teal.code snippets from this article.

There are also teal.code snippets in another vignette (Creating Custom Modules), so removal from this one would not remove the Suggests dependency for the teal.code package anyway.

I also reviewed the text and tried to polish it.

Lastly, there examples in R/module_tabs_with_filters.R were updated during #870

@m7pr m7pr added the core label Jul 21, 2023
@chlebowa chlebowa self-assigned this Jul 24, 2023
@m7pr
Copy link
Contributor Author

m7pr commented Jul 24, 2023

Thanks for review @chlebowa

m7pr and others added 8 commits July 24, 2023 12:37
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
m7pr and others added 2 commits July 24, 2023 13:02
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
vignettes/adding-support-for-reporting.Rmd Outdated Show resolved Hide resolved
vignettes/adding-support-for-reporting.Rmd Outdated Show resolved Hide resolved
vignettes/adding-support-for-reporting.Rmd Outdated Show resolved Hide resolved
vignettes/adding-support-for-reporting.Rmd Outdated Show resolved Hide resolved
vignettes/adding-support-for-reporting.Rmd Outdated Show resolved Hide resolved
vignettes/adding-support-for-reporting.Rmd Outdated Show resolved Hide resolved
m7pr and others added 7 commits July 26, 2023 09:16
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Marcin <[email protected]>
@m7pr
Copy link
Contributor Author

m7pr commented Jul 27, 2023

Waiting for #872

@m7pr m7pr added blocked and removed blocked labels Jul 27, 2023
@m7pr m7pr marked this pull request as ready for review July 27, 2023 14:10
@m7pr m7pr requested a review from chlebowa July 27, 2023 14:10
@github-actions
Copy link
Contributor

github-actions bot commented Jul 27, 2023

badge

Code Coverage Summary

Filename                         Stmts    Miss  Cover    Missing
-----------------------------  -------  ------  -------  -----------------------------------------------------------------------------
R/dummy_functions.R                 88      63  28.41%   9-76, 101-104, 107-111
R/get_rcode_utils.R                 46       1  97.83%   49
R/include_css_js.R                  24       0  100.00%
R/init.R                            76      28  63.16%   169-176, 181-202, 214-216
R/module_filter_manager.R          101      29  71.29%   62-70, 79-84, 216, 221-234
R/module_nested_tabs.R             171      16  90.64%   71, 118, 122-123, 137-144, 161, 211, 233, 266
R/module_snapshot_manager.R        139     103  25.90%   71-82, 109-118, 122-134, 136-143, 149-164, 177-200, 203-214, 217-223, 250-272
R/module_tabs_with_filters.R        67       2  97.01%   95, 134
R/module_teal_with_splash.R         33       2  93.94%   65, 77
R/module_teal.R                    164      12  92.68%   68, 71, 158-159, 209-210, 230-233, 235, 239
R/modules_debugging.R               18      18  0.00%    25-44
R/modules.R                        108      11  89.81%   314-357
R/reporter_previewer_module.R       16       2  87.50%   23, 27
R/show_rcode_modal.R                20      20  0.00%    16-37
R/tdata.R                           41       2  95.12%   146, 172
R/teal_reporter.R                   60       5  91.67%   65, 116-117, 120, 137
R/teal_slices.R                     45       0  100.00%
R/utils.R                           21       0  100.00%
R/validate_inputs.R                 32       0  100.00%
R/validations.R                     62      39  37.10%   111-375
R/zzz.R                             11       7  36.36%   3-14
TOTAL                             1343     360  73.19%

Diff against main

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

Results for commit: 94d20ea

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

@github-actions
Copy link
Contributor

Unit Tests Summary

    1 files    16 suites   14s ⏱️
171 tests 171 ✔️ 0 💤 0
341 runs  341 ✔️ 0 💤 0

Results for commit c8a435c.

@m7pr m7pr merged commit 4dea971 into main Jul 28, 2023
21 of 22 checks passed
@m7pr m7pr deleted the 818_documentation_cleanup@main branch July 28, 2023 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation fixes
2 participants