github/shiny
1
1
Fork 0
mirror of https://github.com/rstudio/shiny.git synced 2026-01-11 07:58:11 -05:00
Code Issues Packages Projects Releases Wiki Activity

add documentation for showcase mode parameter to runApp

Browse Source
This commit is contained in:
Jonathan McPherson
2013-12-16 09:25:02 -08:00
parent d5cdaddeea
commit bd265c00a0
2 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
R/shiny.R
View File

@@ -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{

9
man/runApp.Rd
View File

@@ -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