Skip to content

Conversation

@m7pr
Copy link
Contributor

@m7pr m7pr commented Feb 11, 2025

Part of insightsengineering/teal#1475

Adds some explanation about decorators functionality of tmg, since we will remove/reduce confusing decorators vignette in teal. Heavily based on Customizing Module Output vignette currently existing in teal, with adjustments to show teal.modules.general modules.

https://github.com/insightsengineering/teal/blob/c70299587cdf8280c75f7320ae09cd3c67c79837/vignettes/customizing-module-output.Rmd

@m7pr m7pr added the core label Feb 11, 2025
@m7pr m7pr requested review from llrs-roche and vedhav February 11, 2025 11:27
@github-actions
Copy link
Contributor

github-actions bot commented Feb 11, 2025

badge

Code Coverage Summary

Filename                      Stmts    Miss  Cover    Missing
--------------------------  -------  ------  -------  ---------------------------------------
R/tm_a_pca.R                    889     889  0.00%    139-1161
R/tm_a_regression.R             777     777  0.00%    178-1060
R/tm_data_table.R               211     211  0.00%    100-359
R/tm_file_viewer.R              173     173  0.00%    47-255
R/tm_front_page.R               144     133  7.64%    77-247
R/tm_g_association.R            346     346  0.00%    159-580
R/tm_g_bivariate.R              690     426  38.26%   331-818, 859, 970, 987, 1005, 1016-1038
R/tm_g_distribution.R          1119    1119  0.00%    156-1422
R/tm_g_response.R               369     369  0.00%    177-625
R/tm_g_scatterplot.R            731     731  0.00%    260-1095
R/tm_g_scatterplotmatrix.R      296     277  6.42%    198-531, 592, 606
R/tm_missing_data.R            1133    1133  0.00%    124-1434
R/tm_outliers.R                1041    1041  0.00%    163-1355
R/tm_t_crosstable.R             261     261  0.00%    163-472
R/tm_variable_browser.R         832     827  0.60%    89-1078, 1116-1299
R/utils.R                       151     135  10.60%   87-272, 302-338, 350-359, 364, 378-397
R/zzz.R                           2       2  0.00%    2-3
TOTAL                          9165    8850  3.44%

Diff against main

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

Results for commit: a9ceb1d

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

@github-actions
Copy link
Contributor

github-actions bot commented Feb 11, 2025

Unit Tests Summary

  1 files   22 suites   13m 14s ⏱️
144 tests 144 ✅ 0 💤 0 ❌
475 runs  475 ✅ 0 💤 0 ❌

Results for commit a9ceb1d.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 11, 2025

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
examples 💔 $0.58$ $+4.38$ $+1$ $-37$ $0$ $0$
shinytest2-tm_a_pca 💔 $116.19$ $+2.15$ $0$ $0$ $0$ $0$
shinytest2-tm_a_regression 💔 $52.24$ $+1.25$ $0$ $0$ $0$ $0$
shinytest2-tm_g_bivariate 💔 $73.50$ $+1.40$ $0$ $0$ $0$ $0$
shinytest2-tm_g_distribution 💔 $57.39$ $+1.04$ $0$ $0$ $0$ $0$
shinytest2-tm_g_scatterplot 💔 $73.26$ $+1.14$ $0$ $0$ $0$ $0$
shinytest2-tm_outliers 💔 $109.06$ $+3.51$ $0$ $0$ $0$ $0$
Additional test case details
Test Suite $Status$ Time on main $±Time$ Test Case
examples 💔 $0.08$ $+1.65$ example_add_facet_labels.Rd

Results for commit c22539b

♻️ This comment has been updated with latest results.

Copy link
Contributor

@llrs-roche llrs-roche left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I provided some comments and suggestions on the vignette. It is very easy to follow.

One technical note is to split long lines by each sentence instead of in the middle of one. This makes it nicer diff if only one sentences is modified and also shows which sentences are more complex.

vedhav and others added 11 commits February 14, 2025 16:05
# Conflicts:
#	R/tm_a_pca.R
#	R/tm_a_regression.R
#	R/tm_g_association.R
#	R/tm_g_bivariate.R
#	R/tm_g_distribution.R
#	R/tm_g_response.R
#	R/tm_g_scatterplot.R
#	R/tm_g_scatterplotmatrix.R
#	R/tm_missing_data.R
#	R/tm_outliers.R
#	R/tm_t_crosstable.R
#	man/tm_a_pca.Rd
#	man/tm_a_regression.Rd
#	man/tm_g_association.Rd
#	man/tm_g_bivariate.Rd
#	man/tm_g_distribution.Rd
#	man/tm_g_response.Rd
#	man/tm_g_scatterplot.Rd
#	man/tm_g_scatterplotmatrix.Rd
#	man/tm_missing_data.Rd
#	man/tm_outliers.Rd
#	man/tm_t_crosstable.Rd
@vedhav vedhav force-pushed the 1475_vignettes@main branch from 7dc69d4 to a3bed0a Compare February 24, 2025 16:28
@vedhav vedhav force-pushed the 1475_vignettes@main branch from 5f29646 to a9ceb1d Compare February 25, 2025 04:48
@vedhav vedhav enabled auto-merge (squash) February 25, 2025 05:10
@vedhav vedhav merged commit fbf27a0 into main Feb 25, 2025
29 checks passed
@vedhav vedhav deleted the 1475_vignettes@main branch February 25, 2025 18:50
@github-actions github-actions bot locked and limited conversation to collaborators Feb 25, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants