Defines functions add_options

Documented in add_options

#' Pass objects and customization options to a shiny app
#' @description Provides a general method for passing arguments to shiny apps
#'     allowing for dynamic customization.
#' @importFrom shiny getShinyOption shinyOptions HTML
#' @param opts A \code{list} of additional options or objects to pass to a shiny app
#' @param dir A \code{character} string indicating the path to the directory containing ui.R and server.R
#' @param theme A \code{character} string naming a Bootswatch color theme (used by \code{shinythemes::shinytheme})
#' @param icon  A \code{character} string naming a fontAwesome icon to be placed in the footer of a navbarPage app
#' @param img A \code{character} string for the path/url of an image to be placed in the footer of a navbarPage app
#' @param git_user A \code{character} string for github username used in the branding link
#' @details Shiny apps are not functions. Thus, customization options cannot be
#'     passed to a shiny app as simply as arguments are passed between functions.  Further,
#'     the manner in which objects are loaded prior to deploying an app differ if the app
#'     will be published as a stand-alone or embedded within an rmarkdown docmuent.
#'     Assigning objects as \code{shiny::shinyOptions} ensures that these values are 
#'     passed to a shiny app and can be deployed.
#' @return A list of shiny options set with \code{shinyOptions} 
#' @seealso \code{\link{add_css}}
#' @seealso \code{\link{add_logo}}
#' @export
add_options <- 
         theme = 'flatly', 
         icon = NULL,
         img = NULL,
         git_user = NULL) 

if(!is.na(opts)) { 
aso <- lapply(X = 1:length(opts), 
       FUN = function(x) {
             eval(parse(text = paste(collapse = '',

     CSS <- system.file('teachingApps','css','teachingApps.css', package = 'teachingApps')
    options('markdown.HTML.stylesheet' = CSS)
    shiny::shinyOptions('theme'   = theme)
    shiny::shinyOptions('appDir'  = dir)
    shiny::shinyOptions('appName' = basename(dir))
    shiny::shinyOptions('icon'    = icon)
    shiny::shinyOptions('img'     = img)
    shiny::shinyOptions('gitUser' = git_user)

Try the teachingApps package in your browser

Any scripts or data that you put into this service are public.

teachingApps documentation built on July 1, 2020, 5:58 p.m.