embed hosted apps in shiny vignette

corybrunson / ggalluvial

ggplot2 extension for alluvial plots

http://corybrunson.github.io/ggalluvial/

GNU General Public License v3.0

497 stars 34 forks source link

embed hosted apps in shiny vignette #84

Closed qdread closed 3 years ago

qdread commented 3 years ago

Resolves #82 . It was simpler than I thought! Hopefully the apps will be hosted more or less indefinitely on the shinyapps.io server. If not, we will have to come up with a new solution.

Summary of proposed changes:

uses knitr::include_app() to embed the apps in the vignette, I think it's fine to use this as the vignette rendering engine already depends on knitr so this adds no new dependencies.
now this should work once the pkgdown site is built, as well as with browseVignettes(). It does not work with vignette() though. I've asked a question about this on rstudio forum. If I get an answer I will update further but I think this is good for now.

corybrunson commented 3 years ago

I just tried out a Shiny app i haven't touched in 3 years. It still works fine, so that seems like a medium-term solution, at least : ) I'll check this out today!

corybrunson commented 3 years ago

The package installs, the vignette is readable, and i can view both embedded apps locally using the provided code. The apps do not display in the windows using vignette() as you mentioned. If you don't find a solution, then i think it'll be important to state explicitly that the user should not expect them to appear (as you do in the case that the user does not have Internet access). If you find a solution, then we'll be prompted to update such a statement, so i request adding it now, to be sure it's there in case a solution is not found. Otherwise, ready to merge. : ) After the merge i'll start a new Travis-CI check.

corybrunson commented 3 years ago

@qdread could you verify that the HTML pages generated by browseVignettes() show the embedded apps for you, after installing the clarification statement? They don't for me, but it may be because my browsers have javascript disabled (or some other switch switched).

qdread commented 3 years ago

Yes I ran:

devtools::build_vignettes()
devtools::load_all()
browseVignettes(package = 'ggalluvial')

and the embedded app is shown when I look at the html page locally:

corybrunson commented 3 years ago

What about after package installation, rather than after an in-session build and load?

qdread commented 3 years ago

Yes, after restarting my session and calling devtools::install_github("qdread/ggalluvial", build_vignettes = TRUE), it still works.