mirror of
https://github.com/rstudio/shiny.git
synced 2026-01-10 07:28:01 -05:00
dde266768c
These functions were temporarily ripped out of Shiny and moved to the htmltools package. We've discovered that it's safe to keep including them in shiny; as long as the functions in shiny and the functions in htmltools are identical, the user won't receive a conflict warning.
81 lines
2.4 KiB
R
81 lines
2.4 KiB
R
% Generated by roxygen2 (4.0.1): do not edit by hand
|
|
\name{shinyApp}
|
|
\alias{as.shiny.appobj}
|
|
\alias{as.shiny.appobj.character}
|
|
\alias{as.shiny.appobj.list}
|
|
\alias{as.shiny.appobj.shiny.appobj}
|
|
\alias{print.shiny.appobj}
|
|
\alias{shinyApp}
|
|
\alias{shinyAppDir}
|
|
\title{Create a Shiny app object}
|
|
\usage{
|
|
shinyApp(ui, server, onStart = NULL, options = list(), uiPattern = "/")
|
|
|
|
shinyAppDir(appDir, options = list())
|
|
|
|
as.shiny.appobj(x)
|
|
|
|
\method{as.shiny.appobj}{shiny.appobj}(x)
|
|
|
|
\method{as.shiny.appobj}{list}(x)
|
|
|
|
\method{as.shiny.appobj}{character}(x)
|
|
|
|
\method{print}{shiny.appobj}(x, ...)
|
|
}
|
|
\arguments{
|
|
\item{ui}{The UI definition of the app (for example, a call to
|
|
\code{fluidPage()} with nested controls)}
|
|
|
|
\item{server}{A server function}
|
|
|
|
\item{onStart}{A function that will be called before the app is actually run.
|
|
This is only needed for \code{shinyAppObj}, since in the \code{shinyAppDir}
|
|
case, a \code{global.R} file can be used for this purpose.}
|
|
|
|
\item{options}{Named options that should be passed to the `runApp` call. You
|
|
can also specify \code{width} and \code{height} parameters which provide a
|
|
hint to the embedding environment about the ideal height/width for the app.}
|
|
|
|
\item{uiPattern}{A regular expression that will be applied to each \code{GET}
|
|
request to determine whether the \code{ui} should be used to handle the
|
|
request. Note that the entire request path must match the regular
|
|
expression in order for the match to be considered successful.}
|
|
|
|
\item{appDir}{Path to directory that contains a Shiny app (i.e. a server.R
|
|
file and either ui.R or www/index.html)}
|
|
|
|
\item{x}{Object to convert to a Shiny app.}
|
|
|
|
\item{...}{Additional parameters to be passed to print.}
|
|
}
|
|
\value{
|
|
An object that represents the app. Printing the object will run the
|
|
app.
|
|
}
|
|
\description{
|
|
These functions create Shiny app objects from either an explicit UI/server
|
|
pair (\code{shinyApp}), or by passing the path of a directory that
|
|
contains a Shiny app (\code{shinyAppDir}). You generally shouldn't need to
|
|
use these functions to create/run applications; they are intended for
|
|
interoperability purposes, such as embedding Shiny apps inside a \pkg{knitr}
|
|
document.
|
|
}
|
|
\examples{
|
|
\dontrun{
|
|
shinyApp(
|
|
ui = fluidPage(
|
|
numericInput("n", "n", 1),
|
|
plotOutput("plot")
|
|
),
|
|
server = function(input, output) {
|
|
output$plot <- renderPlot( plot(head(cars, input$n)) )
|
|
},
|
|
options=list(launch.browser = rstudio::viewer)
|
|
)
|
|
|
|
shinyAppDir(system.file("examples/01_hello", package="shiny"))
|
|
}
|
|
}
|
|
|