Vignette: shiny as a module

[gogonzo]

closes #1450

[github-actions]

Unit Tests Summary

  1 files   28 suites   11m 6s ⏱️
278 tests 274 ✅ 4 💤 0 ❌
540 runs  536 ✅ 4 💤 0 ❌

Results for commit 58bd91d.

♻️ This comment has been updated with latest results.

[github-actions]

Unit Test Performance Difference

Test Suite	$Status$	Time on main	$±Time$	$±Tests$	$±Skipped$	$±Failures$	$±Errors$
module_teal	💔	$129.70$	$+10.23$	$0$	$0$	$0$	$0$
shinytest2-data_summary	💔	$50.83$	$+4.35$	$0$	$0$	$0$	$0$
shinytest2-decorators	💔	$22.86$	$+1.08$	$0$	$0$	$0$	$0$
shinytest2-filter_panel	💔	$41.63$	$+2.03$	$0$	$0$	$0$	$0$
shinytest2-init	💔	$28.19$	$+1.66$	$0$	$0$	$0$	$0$
shinytest2-landing_popup	💔	$46.06$	$+2.16$	$0$	$0$	$0$	$0$
shinytest2-module_bookmark_manager	💔	$36.31$	$+2.47$	$0$	$0$	$0$	$0$
shinytest2-modules	💔	$39.32$	$+1.94$	$0$	$0$	$0$	$0$
shinytest2-reporter	💔	$66.68$	$+2.54$	$0$	$0$	$0$	$0$

Results for commit 462e434

♻️ This comment has been updated with latest results.

[llrs-roche]

Looks good some minor comments about wording. Feel free to ignore

[llrs-roche]

Perhaps a final comment on the example would be good. Like describing the differences with a pure teal app from the final end user (or for the app developer: would it work without teal_data() ? )

[gogonzo]

describing the differences with a pure teal app from the final end user

What do you mean? Isn't "Unlike init(), this module will not automatically include session info footer" enough?

would it work without teal_data()

No it wouldn't. But what do you think I should add? data, modules and filter arguments are well documented in module_teal.

[llrs-roche]

What do you mean? Isn't "Unlike init(), this module will not automatically include session info footer" enough?

For example, when I created this app, the left panel was not there, this is evident for us but it might not be so for new users or app developers that might not know how it works. I usually struggle with vignettes that don't lower the level and assume the user already knows the package.

would it work without teal_data()

No it wouldn't. But what do you think I should add? data, modules and filter arguments are well documented in module_teal.

The idea behind vignettes in my opinion are to serve as introduction to the user. If this is documented on module_teal we can mention this to redirect the users to the detailed documentation of the function or to other vignettes.

My personal preference is to provide extra guidance than assume the user already knows something and not following through the vignette. But it is hard to set the level required for a vignette. Please feel free to resolve this conversation

[donyunardi]

Suggested change

	```{r setup}
	```{r setup, message = FALSE}

We got message in the vignettes when the library is loaded:

Let's hide these messages.

[llrs-roche]

I think it is better to use: suppressPackageStartupMessages(library("teal")) as it makes it evident to the user that there will be some messages on loading the library (and are not caught off guard if the messages appear when on the vignette there are none).

[gogonzo]

I don't have an opinion about what is better, but if you believe so I probably should change all library(teal) in the package's vignettes.

[llrs-roche]

I mean for me it is not super critical. On the other side sometimes people is surprised when a certain function appears on their namespace or it is masked by a new loaded package.