Add new vignette by osenan · Pull Request #68 · insightsengineering/teal.picks

osenan · 2026-05-05T00:13:51Z

Adding a new vignette that explains how to select choices and selected values in picks datasets, variables and values

github-actions · 2026-05-05T00:19:51Z

Unit Test Performance Difference

Test Suite	$Status$	Time on `main`	$±Time$	$±Tests$	$±Skipped$	$±Failures$	$±Errors$
badge_dropdown	💀	$0.16$	$-0.16$	$-1$	$-1$	$0$	$0$

Additional test case details

Test Suite	$Status$	Time on `main`	$±Time$	Test Case
assertion	👶		$+0.02$	unnamed
badge_dropdown	💀	$0.16$	$-0.16$	shinytest2_badge_dropdown_is_visible_when_clicking_on_it_multiple_times

Results for commit 339cb5c

♻️ This comment has been updated with latest results.

github-actions · 2026-05-05T00:25:07Z

Code Coverage Summary

Filename                  Stmts    Miss  Cover    Missing
----------------------  -------  ------  -------  -------------------------------------------------------------
R/as_picks.R                140      21  85.00%   63, 167-171, 182-186, 201-207, 229-231
R/assertion.R                 5       0  100.00%
R/call_utils.R              147      33  77.55%   23-28, 65, 132-138, 259, 278-289, 292, 317-325
R/helpers.R                  12      12  0.00%    4-15
R/interaction.R              42      26  38.10%   39-97
R/module_merge.R            266      14  94.74%   303, 310-320, 337, 616
R/module_picks.R            318      23  92.77%   47-53, 71, 109-110, 298-300, 302-306, 429, 478, 516, 528, 536
R/picks.R                   183       1  99.45%   335
R/print.R                    36       2  94.44%   50, 58
R/resolver.R                141      19  86.52%   80-83, 110-118, 284-289
R/tidyselect-helpers.R       29       0  100.00%
R/tm_merge.R                 54      54  0.00%    42-102
R/ui_containers.R            42       0  100.00%
R/zzz.R                       5       5  0.00%    3-11
TOTAL                      1420     210  85.21%

Diff against main

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

Results for commit: 228499e

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

github-actions · 2026-05-05T00:25:50Z

Unit Tests Summary

1 files 10 suites 16s ⏱️
255 tests 241 ✅ 14 💤 0 ❌
383 runs 368 ✅ 15 💤 0 ❌

Results for commit 228499e.

♻️ This comment has been updated with latest results.

m7pr · 2026-05-05T11:45:35Z

+## Overview
+
+Every `picks()` object is built from three kinds of building blocks: `datasets()`, `variables()`,
+and `values()`. Each one carries two core arguments:
+
+- `choices` — the full set of options the app user can pick from.
+- `selected` — the subset that is pre-selected when the app starts.
+
+```
+picks(
+  datasets(choices = <what datasets the user may choose>, selected = <default dataset>),
+  variables(choices = <what columns the user may choose>, selected = <default columns>),
+  values(choices   = <what values the user may filter to>, selected = <default filter values>)
+)


I don't think we need a new vignette, since we already have a vignette with the overall information like this

Merged to the main vignette here. On the other hand now the vignette is not as short as it used to be.

m7pr · 2026-05-05T11:46:04Z

+Choices and selections can be expressed in three ways:
+
+| Approach | Works with |
+|---|---|
+| Explicit — character vector, integer index, or numeric range | `datasets()`, `variables()`, `values()` |
+| `tidyselect` helpers — `everything()`, `starts_with()`, `where()`, … | `datasets()`, `variables()` only |
+| Function — an R function applied at runtime to the data | `datasets()`, `variables()`, `values()` |
+
+The sections below walk through each approach with runnable examples.


Just move this information and the below to the main vignette

Done in here!

m7pr · 2026-05-05T11:46:15Z

+
+```{r data, message = FALSE}
+library(teal.data)
+library(teal.picks)


Suggested change

library(teal.picks)

We need 1 of these for the vignette to build :-) it cannot be silent as in examples

I removed anyway as the data is loaded by the main vignette

m7pr · 2026-05-05T11:47:13Z

+resolver(x = p_datasets, data = as.list(data))
+resolver(x = p_variables, data = as.list(data))
+resolver(x = p_values, data = as.list(data))


Is resolver an exported funtion? Do user need to know this function?

We do not need it. Indeed it is confusing. I removed here. It is exported, btw.

m7pr

Overall looks good. I would only move this content to the main vignette. Also, I would not mention resolver. No need to call library(teal.picks) since this package is loaded when vignette is compiled.

averissimo · 2026-05-05T12:56:02Z

+})
+
+join_keys(data) <- join_keys(
+  teal.data::join_key("ADSL", "ADLB", keys = "USUBJID")


These datasets are very incomplete, why not use teal.data::rADXX and teal.data::default_cdisc_join_keys[c("ADLB")]

Or add STUDYID to at least have the primary keys.

I added the teal.data synthetic datasets, as you suggested here. I think it is an improvement

I added the teal.data datasets as suggested. Here.

averissimo · 2026-05-05T13:00:26Z

+
+| Approach | Works with |
+|---|---|
+| Explicit — character vector, integer index, or numeric range | `datasets()`, `variables()`, `values()` |


Consider adding a default row of what happens when defaults are assumed

Nice suggestion. Done here.

averissimo · 2026-05-05T13:04:30Z

+
+---
+
+## 1. Explicit choices


Is explicit the right term?

User-defined, static, ?

Should it also reference what happens when choice doesn't exist

resolver( teal.picks::picks(teal.picks::datasets("ADSL"), teal.picks::variables(c("yada"))), teal.data::teal_data(ADSL = teal.data::rADSL) ) #' warnings... #' <picks> #' <datasets>: #' choices: ADSL #' selected: ADSL #' multiple=FALSE, ordered=FALSE, fixed=TRUE #' <variables>: #' choices: ~ #' selected: ~ #' multiple=FALSE, ordered=FALSE, fixed=TRUE, allow-clear=FALSE

averissimo

Almost there! 🥳

Take special look at the defaults for datasets() as I believe it's not consistent with API documentation and functinality

Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

averissimo

Looks good!

Please add configuration to pkgdown to show articles index in main page.

averissimo · 2026-05-06T13:43:21Z

Please make a change in _pkgdown.yml to include all vignettes in site build

docs: add new vignette for choices or selections

1f4e6e8

osenan added the core label May 5, 2026

github-actions Bot and others added 2 commits May 5, 2026 00:15

[skip style] [skip vbump] Restyle files

4dfea9b

chore: fix spelling

5dc6fb4

osenan requested a review from a team May 5, 2026 10:55

m7pr reviewed May 5, 2026

View reviewed changes

m7pr approved these changes May 5, 2026

View reviewed changes

averissimo reviewed May 5, 2026

View reviewed changes

Comment thread vignettes/teal-picks-choices-and-selections.Rmd Outdated

docs: modify vignettes based on review feedback

2e4d705

osenan requested a review from averissimo May 5, 2026 15:57

averissimo requested changes May 5, 2026

View reviewed changes

osenan and others added 7 commits May 5, 2026 18:57

Update vignettes/teal-picks-in-teal.Rmd

fd1fc49

Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

Update vignettes/teal-picks-in-teal.Rmd

860776b

Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

Update vignettes/teal-picks-in-teal.Rmd

f3b570d

Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

Update vignettes/teal-picks-in-teal.Rmd

6d723cc

Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

Update vignettes/teal-picks-in-teal.Rmd

418750a

Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

Update vignettes/teal-picks-in-teal.Rmd

271a880

Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

docs: fix vignette defaults

80bfd5e

osenan requested a review from averissimo May 5, 2026 17:10

averissimo approved these changes May 6, 2026

View reviewed changes

chore: add vignettes into page

7dba211

Merge branch 'main' into vignettes-tidyverse@main

228499e

osenan merged commit dc8572d into main May 6, 2026
27 of 28 checks passed

osenan deleted the vignettes-tidyverse@main branch May 6, 2026 15:08

github-actions Bot locked and limited conversation to collaborators May 6, 2026

Conversation

osenan commented May 5, 2026

Uh oh!

github-actions Bot commented May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Test Performance Difference

Uh oh!

github-actions Bot commented May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage Summary

Diff against main

Uh oh!

github-actions Bot commented May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Tests Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

m7pr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

averissimo May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

averissimo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

averissimo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented May 5, 2026 •

edited

Loading

github-actions Bot commented May 5, 2026 •

edited

Loading

github-actions Bot commented May 5, 2026 •

edited

Loading

averissimo May 5, 2026 •

edited

Loading