mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
32f93a2be1
* Update roxygen and regenerate. Mostly just whitespace changes and `code` -> `verb`. * R6 documentation for MockShinySession * Install roxygen from GH * % are now auto-escaped (We still need to go find the rest) * Fixed the ramining \% in roxygen Found looking for ^#'.*\\% in all R files, so I believe this is all of them. * Regenerate docs * Decreate indent in roxygen so paragraphs don't get interpreted as code blocks. https://github.com/r-lib/roxygen2/issues/948#issuecomment-546386172 * Namespace * Add MockShinySession reference to pkgdown. * Clean up test warnings * Export session
49 lines
1.5 KiB
R
49 lines
1.5 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/server.R
|
|
\name{runExample}
|
|
\alias{runExample}
|
|
\title{Run Shiny Example Applications}
|
|
\usage{
|
|
runExample(
|
|
example = NA,
|
|
port = NULL,
|
|
launch.browser = getOption("shiny.launch.browser", interactive()),
|
|
host = getOption("shiny.host", "127.0.0.1"),
|
|
display.mode = c("auto", "normal", "showcase")
|
|
)
|
|
}
|
|
\arguments{
|
|
\item{example}{The name of the example to run, or \code{NA} (the default) to
|
|
list the available examples.}
|
|
|
|
\item{port}{The TCP port that the application should listen on. Defaults to
|
|
choosing a random port.}
|
|
|
|
\item{launch.browser}{If true, the system's default web browser will be
|
|
launched automatically after the app is started. Defaults to true in
|
|
interactive sessions only.}
|
|
|
|
\item{host}{The IPv4 address that the application should listen on. Defaults
|
|
to the \code{shiny.host} option, if set, or \code{"127.0.0.1"} if not.}
|
|
|
|
\item{display.mode}{The mode in which to display the example. Defaults to
|
|
\code{showcase}, but may be set to \code{normal} to see the example without
|
|
code or commentary.}
|
|
}
|
|
\description{
|
|
Launch Shiny example applications, and optionally, your system's web browser.
|
|
}
|
|
\examples{
|
|
## Only run this example in interactive R sessions
|
|
if (interactive()) {
|
|
# List all available examples
|
|
runExample()
|
|
|
|
# Run one of the examples
|
|
runExample("01_hello")
|
|
|
|
# Print the directory containing the code for all examples
|
|
system.file("examples", package="shiny")
|
|
}
|
|
}
|