R/pabloGift.R

In lcolladotor/pablo2013: Pablo's 2013 christmas gift

#' Open the quiz for Pablo's 2013 gift
#'
#' Opens the Shiny application that is the gift per se. It is a quiz, with better gift the better you perform.
#'
#' @param port The TCP port that the application should listen on. Defaults to port 8100. (Taken from \link[shiny]{runApp})
#' @param launch.browser If \code{TRUE}, the system's default web browser will be launched automatically after the app is started.
#'
#' @details This function runs the Shiny application including in this package. It is basically a wrapper for \link[shiny]{runApp}.
#'
#' @return The Shiny application is opened in your browser. To stop the function from running you have to cancel the command using ctrl + c or the equivalent shortcut in your system.
#'
#' @examples
#' \dontrun{
#' ## Open the Shiny application
#' pabloGift()
#' ## Remember to cancel the command to get back to the R console once you are done analyzing your own data.
#' }
#' @export
#' @references For more information on what a Shiny app is check http://www.rstudio.com/shiny/

pabloGift <- function(port = 8100L, launch.browser = TRUE) {
	# Required packages	
	library(shiny)
	
	## Locate the Shiny code
	root <- "pabloGift"
	srcdir <- system.file(root, package="pablo2013")
	
	## Run the shiny application
	runApp(appDir=srcdir, port=port, launch.browser=launch.browser)
	
}