Announcing ShinyTester – a package that helps you build Shiny apps

Shiny is awesome, but can be a bit daunting and easy to make mistakes in. I recently came back to Shiny after a hiatus of a few years and it was much more challenging than I feel comfortable admitting. I was making bonehead mistakes like writing something instead of output$something, confusing where to put Output commands vs Render commands, etc. I would eventually find my mistake, curse myself and move on with a crumpled ego. Then I had the realization that maybe if I was a beginner, I wouldn’t even know what I was doing wrong. Thusly did I conclude that I was in a unique position to help out the R community: Dumb enough to make mistakes, but experienced enough to eventually remember how to resolve them. So naturally, I wrote an R package that tests the code of the Shiny app itself.

 

To install: install.packages("ShinyTester") cause yes, it’s on CRAN (my first!!! Shoutout to @jbkunst for invaluable help!)

 

Quick caveat: Since this package parses code and everyone writes code differently, it will necessarily be super buggy. If this package doesn’t work for your app (after reading the full list of caveats at the bottom of this post), please help by opening an Issue on the github repo.

 

The package consists of two functions that analyze the code itself:

  • ShinyDummyCheck() – checks how items are created in server.R and then how they are called in ui.R and runs some fairly naive checks
  • ShinyHierarchy() – to create an ad hoc hirearchy of the structure of the Shiny Apps – ie – what inputs go to what reactives, what reactives go to other reactives, and what then gets pushed back out to the UI as an output.

It is my hope that both of these combined minimize the intrinsic boneheadedness in us all. This is really quite beta though… please do check the Caveats! In the meantime, some examples:

Examples for ShinyDummyCheck:

ShinyTester::ShinyDummyCheck("https://raw.githubusercontent.com/mexindian/ShinyServer/master/LineSelector")

Provides this table:

 

Which shows that there are no errors in the Shiny app, oh except for the fact that I defined an object twice… whoops (Yeah, see that’s exactly the boneheadedness I’m talkin bout). The structure of the table is as follows:

 

  • Item – The name of the asset that maybe should be on both server.R and ui.R
  • SrvCall – the TYPE of object that you’re saying this specific item is (in server.R)
  • isOutput – is a binary that will specify if in server.R you wrote just item or output$item
  • VisualCall – is the TYPE of thingie you’re trying to push the item into (in ui.R).
  • Status – Compares the SrvCall to the VisualCall, also looks at isOutput and then applies some rules to figure out if it’s probably ok or not

Examples for ShinyHierarchy:

A simple example:

library(ShinyTester)
ShinyHierarchy("https://raw.githubusercontent.com/rstudio/shiny-examples/master/003-reactivity")

Will yield:

image

 

Which shows one of the weaknesses of the function… it assumes all Item names are unique… and will act strangely if this assumption doesn’t hold (ie – caption).

 

A more complex example:

ShinyTester::ShinyHierarchy("https://raw.githubusercontent.com/mexindian/ShinyServer/master/LineSelector")

Yields:

image

And here we can start to see the structure that I’m attempting to show… there are basically three ROWS of nodes. The first one is the UI Inputs, the second row are the reactives (kinda…), and the third row are the outputs being visualized. I said the reactives are “kinda” the second row because I have introduced a small shift to each node in the middle row in order to see reactive flows into each other (if they are all in the same row, you can’t really see them). The structure is made evident in a more complex case below (forgive the redacted names):

image

If you want to suppress the shift in reactive nodes, use offsetReactives = F

Caveats:

This is a very naive app, and in early stages at that… it works best with my style of programming and will probably take significant work to universalize (since we’re talking about code… maybe it’s impossible to fully universalize).  Some other caveats:

  • For now only works with <- assignments, not = or -> assignments
  • For now calling items only works with doublequotes. (ie. plotOutput("thingie") works, plotOutput('thingie') doesn’t.
  • For now, only supports seperate ui.R and server.R Shiny apps… the single app.R implementation is not supported.
  • isolate and observe are not supported yet
  • For now, I don’t read in data outside the shinyserver call (for example, if I want to pass data in that only needs to be calculated once. Not sure yet what’s the best way.
  • For now it only analyzes the main scripts, if you are SOURCEing files in from other places, it won’t work.

Other tips for working in Shiny:

  • Add to your server.R and ui.R TEST items. for example, add one for a data.frame and one for a figure. You can keep these commented out or displaying random data… then, when you add a new element, just test them in the test blocks before adding them to the exact place. Saves time.
  • Likewise, during testing, if you need to run through the code to debug, you can always simulate inputs by writing this: input <- data.frame(Parameter1="thingie1",Parameter2="thingie2"). Keep this commented out, but when you test, you can run through the Shiny app as if it were live.
  • Check Dean Attali’s excellent tips and tricks (http://deanattali.com/blog/advanced-shiny-tips/).

 

Enjoy!

(Thanks to my rusers community, especially to Joshua Kunst and Colin Phillips for discussion, help and encouragement required to push this through to CRAN).

  3 comments for “Announcing ShinyTester – a package that helps you build Shiny apps

  1. Bilash Mitra
    2017/02/02 at 09:34

    The ShinyTester makes the management shiny…….

Leave a Reply

%d bloggers like this: