Repository navigation
Add some guidance to user regarding interactive documents #2564
Description
The runtime: shiny vs runtime: shinyrmd distinction is really subtle for someone writing interactive documents.
There are examples where a server.R and ui.Rmd but use runtime: shiny rather than runtime: shinyrmd.
We could add context to rmarkdown::run to understand if the wrong runtime has been specified and guide the user.
Especially:
server.R+ui.Rmdshould always meanruntime: shinyrmdserver: shinyshould be used now (instead ofruntime: shinyrmd
Adding this note to log and remember this possible improvement.
Activity
vpag commentedon Jan 9, 2025
Why should? (Did you mean "server: shiny_prerendered... instead of... shinyrmd", or maybe some deprecations/changes are coming to prerendering-related technique, or smth. else?)
cderv commentedon Jan 10, 2025
I think what I meant was "should recommend" to avoid confusion. And also because on Quarto side, only
server: shinyis supported. https://quarto.org/docs/interactive/shiny/No I meant
server: shiny.server: shiny_prerendereddoes not exist.runtime: shiny_prerenderedis equivalent toruntime: shinyrmd.All this is just several ways to do things. It was introduced through time and can lead to confusion now.
On rmarkdown side, there is no deprecation. So using
runtime: shinyrmdworks. However, for document rendered through Quarto, thenserver: shinyis expected.What does not for sure is using
server.R+ui.Rmdand not usingserver: shiny.Anyhow, this is documentation improvement mainly.
No change coming.
vpag commentedon Jan 10, 2025
Ok, so that is for code style, I see.
With a bit of misunderstanding of "...only
server: shinyis supported" -- I've just got the same html-output for both (server: shinyandruntime: shiny_prerendered) variants withquarto render|serve. Also, as per conditions evaluated at is_shiny_prerendered(), seems like all of those fronmatter options are equivalent for Rmd/qmd, if I'm not missing some case.And for now, anyway,
Superb. Thanks!
cderv commentedon Jan 14, 2025
Internally code is the same. On Quarto side, we do check only for
serverand notruntime. So some processing or checks on Quarto code can be missed if you useruntimewith Quarto. And we don't document it.Anyhow, I labelled it documentation issue anyway. Thanks a lot for your question to help us improve!