README.md

In jbryer/ShinyDemo: Shiny Applications with Parameters

ShinyDemo - Package for Running Shiny Apps Like Package Demos

Author: Jason Bryer ([e-mail])

Website: http://jbryer.github.io/ShinyDemo/

This package is designed to run Shiny apps included in packages in the inst/shiny/ directory. In addition to providing a standardized way of running apps within packages, it extends the typical process of running Shiny apps by allowing function parameters to be passed to the application. Utility functions for the developer are provided to safely check for parameter values and to retrieve defaults if the application is run outside of the package.

Installation

The latest version of the ShinyDemo package can be installed using the `remotes`` package.

remotes::install_github('jbryer/ShinyDemo')

For package developers, simply include your Shiny apps in the inst/ directory within your R package. The ShinyDemo::shiny_demo() function will automatically find those apps.

library('ShinyDemo')
ShinyDemo::shiny_demo()

##     package         app
## 1 ShinyDemo   df_viewer
## 2 ShinyDemo environment
## 3 ShinyDemo     gambler
##                                                                                      app_dir
## 1   /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources/library/ShinyDemo/df_viewer
## 2 /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources/library/ShinyDemo/environment
## 3     /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources/library/ShinyDemo/gambler

You can also pass arbitrary parameters to Shiny applications. The following examples passes a list of data frames to a simple data frame viewer application.

library('ShinyDemo')
data("mtcars"); data("faithful")
runAppWithParams(ui = ShinyDemo::df_viewer_ui,
                 server = ShinyDemo::df_viewer_server,
                 data_frames = list(mtcars = mtcars, faithful = faithful),
                 port = 2112)

Development

This package uses the devtools package for development.

# Generate the package documentation
usethis::use_tidy_description()
devtools::document()
# Install the package
devtools::install()
# Run CRAN check
devtools::check(cran = TRUE)

jbryer/ShinyDemo documentation built on June 13, 2025, 7:55 p.m.