From bd265c00a0740bc91db80a5ad295ddefbdf376fb Mon Sep 17 00:00:00 2001 From: Jonathan McPherson Date: Mon, 16 Dec 2013 09:25:02 -0800 Subject: [PATCH] add documentation for showcase mode parameter to runApp --- R/shiny.R | 5 ++++- man/runApp.Rd | 9 ++++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/R/shiny.R b/R/shiny.R index aedd800b1..1a3b2799e 100644 --- a/R/shiny.R +++ b/R/shiny.R @@ -1391,7 +1391,10 @@ serviceApp <- function() { #' @param workerId Can generally be ignored. Exists to help some editions of #' Shiny Server Pro route requests to the correct process. #' @param quiet Should Shiny status messages be shown? Defaults to FALSE. -#' @param showcase Should the app be run in showcase mode? Defaults to FALSE. +#' @param showcase If true, the application will be started in showcase mode. In +#' showcase mode, the application's code is visible, and additional metadata +#' from \code{DESCRIPTION} and \code{readme.md} files in the application's +#' directory are displayed. Defaults to FALSE. #' #' @examples #' \dontrun{ diff --git a/man/runApp.Rd b/man/runApp.Rd index aafc3f63e..7fcb7df8c 100644 --- a/man/runApp.Rd +++ b/man/runApp.Rd @@ -5,7 +5,7 @@ runApp(appDir = getwd(), port = NULL, launch.browser = getOption("shiny.launch.browser", interactive()), host = getOption("shiny.host", "127.0.0.1"), - workerId = "", quiet = FALSE) + workerId = "", quiet = FALSE, showcase = FALSE) } \arguments{ \item{appDir}{The directory of the application. Should @@ -32,6 +32,13 @@ \item{quiet}{Should Shiny status messages be shown? Defaults to FALSE.} + + \item{showcase}{If true, the application will be started + in showcase mode. In showcase mode, the application's + code is visible, and additional metadata from + \code{DESCRIPTION} and \code{Readme.md} files in the + application's directory are displayed. Defaults to + FALSE.} } \description{ Runs a Shiny application. This function normally does not