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

Datanames in vignettes #1434

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Datanames in vignettes #1434

wants to merge 11 commits into from

Conversation

gogonzo
Copy link
Contributor

@gogonzo gogonzo commented Dec 19, 2024

closing #1380 and insightsengineering/teal.data#338

  • removes set_datanames
  • mentions dot-prefix to exclude dataset

@gogonzo gogonzo added the core label Dec 19, 2024
@gogonzo gogonzo marked this pull request as draft December 19, 2024 12:07
Copy link
Contributor

github-actions bot commented Dec 19, 2024

badge

Code Coverage Summary

Filename                          Stmts    Miss  Cover    Missing
------------------------------  -------  ------  -------  ----------------------------------------------------------------------------------------------------------------------------------------
R/checkmate.R                        24       0  100.00%
R/dummy_functions.R                  67      11  83.58%   41, 43, 85-93
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                             99      42  57.58%   149-158, 160, 172-193, 218-221, 228-234, 237-238, 240
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      37  81.77%   26-54, 68, 78, 232, 263-267
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              227      85  62.56%   40-136, 168, 193-195, 312, 346
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, 303-317, 320-331, 334-340, 354
R/module_teal_data.R                149      76  48.99%   44-150
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                     195      87  55.38%   48-143, 158, 184-185, 224
R/module_transform_data.R           110       4  96.36%   20, 59, 129-130
R/modules.R                         267      60  77.53%   169-173, 228-231, 354-374, 382, 532-538, 551-559, 574-589, 622, 634-642
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                 20       0  100.00%
R/teal_data_utils.R                  10       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/teal_transform_module.R            45       0  100.00%
R/TealAppDriver.R                   353     353  0.00%    55-738
R/utils.R                           245      38  84.49%   391-440
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                              3311    1317  60.22%

Diff against main

Filename       Stmts    Miss  Cover
-----------  -------  ------  -------
R/modules.R      -11     -11  +3.07%
TOTAL            -11     -11  +0.20%

Results for commit: 5cc7110

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Contributor

github-actions bot commented Dec 19, 2024

Unit Tests Summary

  1 files   27 suites   10m 35s ⏱️
275 tests 257 ✅ 18 💤 0 ❌
501 runs  483 ✅ 18 💤 0 ❌

Results for commit 5cc7110.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Dec 19, 2024

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
module_teal 💔 $147.40$ $+5.75$ $0$ $0$ $0$ $0$
shinytest2-landing_popup 💔 $43.49$ $+1.44$ $0$ $0$ $0$ $0$
shinytest2-module_bookmark_manager 💔 $34.20$ $+1.07$ $0$ $0$ $0$ $0$
shinytest2-modules 💔 $37.61$ $+1.17$ $0$ $0$ $0$ $0$

Results for commit 5e0fe5a

♻️ This comment has been updated with latest results.

@gogonzo gogonzo changed the title 338 datanames in vignettes Datanames in vignettes Dec 19, 2024
Comment on lines 244 to 245
data <- data.frame(id = 1:10, x = 11:20)
.data2 <- data.frame(id = 1:20, data_id = c(1:10, 1:10), y = 21:30)
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider adding here a useful case, either using a function or combining 2 datasets

Suggested change
data <- data.frame(id = 1:10, x = 11:20)
.data2 <- data.frame(id = 1:20, data_id = c(1:10, 1:10), y = 21:30)
data <- data.frame(id = 1:10, x = 11:20)
.add_column <- function(x) cbind(data, diff_x = mean(data$x) - data$x)
data <- .add_column(data)
Suggested change
data <- data.frame(id = 1:10, x = 11:20)
.data2 <- data.frame(id = 1:20, data_id = c(1:10, 1:10), y = 21:30)
.data1 <- data.frame(id = 1:10, x = 11:20)
.data2 <- data.frame(id = 1:10, y = 11:20)
data <- merge(.data1, .data2)

ls(my_data)
names(my_data)

app <- teal::init(data = my_data, modules = example_module())
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can ommit the double colon prefix, as init is used without above in this vignette

Suggested change
app <- teal::init(data = my_data, modules = example_module())
app <- init(data = my_data, modules = example_module())

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, absolutely. It is automatic as for me teal::init is an institution :D

@gogonzo gogonzo marked this pull request as ready for review December 19, 2024 16:07
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.

2 participants