R/runExample.R

In kecoli/PCRM: Companion to Portfolio Construction and Risk Management

#' runExample
#'
#' @param example 
#'
#' @return
#' @export
#'
#' @examples
runExample <- function(example) {
	# locate all the shiny app examples that exist
	validExamples <- list.files(system.file("shiny-examples", package = "mpo"))
	
	validExamplesMsg <-
			paste0(
					"Valid examples are: '",
					paste(validExamples, collapse = "', '"),
					"'")
	
	# if an invalid example is given, throw an error
	if (missing(example) || !nzchar(example) ||
			!example %in% validExamples) {
		stop(
				'Please run `runExample()` with a valid example app as an argument.\n',
				validExamplesMsg,
				call. = FALSE)
	}
	
	# find and launch the app
	appDir <- system.file("shiny-examples", example, package = "mpo")
	shiny::runApp(appDir, display.mode = "normal")
}