R/sdGame.R

In farfallawang/mosaicApps: A toolkit for teaching applied math and stats

#Dists to do:
#Unif, t, F, CHI^2, normal, exponential, beta? MY CHOICE, random.

#' Interactive applet to explore the standard deviation
#' 
#' A game where the user matches the standard deviation of the blue normal
#' curve to the unknown standard deviation of the red curve to gain better
#' intuition of what the standard deviation truly measures.
#' 
#' The user attempts to match the standard deviation of the blue normal
#' distribution to that of the red distribution using the Standard Deviation
#' slider. When satisfied with their approximation, the user may check the show
#' solution/next checkbox - this displays the normal distribution with the
#' correct standard deviation in green. It displays the correct standard
#' deviation as text, the user's approximation, and the percent off from the
#' correct standard deviation. If the percent off is less than 20%, the user
#' "wins", if more than 20%, the user "loses".
#' 
#' The default red distribution is a random distribution. The possible red
#' distributions include normal, uniform, exponential, t with 2 to 3 degrees of
#' freedom, t with 3 degrees of freedom, F, and Chi-Squared. Using the
#' distribution picker, the user may choose one distribution to use as the red
#' unknown distribution. This can be used for more focused lessons on specific
#' distributions, practice, or curiosity.
#' 
#' @author Andrew Rich (\email{andrew.joseph.rich@@gmail.com}), Daniel Kaplan
#' (\email{kaplan@@macalester.edu}), Randall Pruim (\email{rpruim@@calvin.edu})
#' , Mengdie Wang(\email{mwang3@@macalester.edu})
#' and Jingjing Yang(\email{jyang1@@macalester.edu})
#' @keywords statistics
#' @examples
#' sdGameApp() #if you do not want to display the code
#' sdGameApp(display = "showcase") #if you want to display the code

#' @export
sdGameApp <- function(display = c("normal","showcase")){
  display = match.arg(display)
  appDir <- system.file("shinyApps","sdGame",package = "mosaicApps")
  if (appDir == ""){
    stop("Couldn't find example directory. Try reinstalling `mosaicApps`.",
         call. = FALSE)
  }
  shiny::runApp(appDir, display.mode = display)
}