runApp {shiny} | R Documentation

## Run Shiny Application

### Description

Runs a Shiny application. This function normally does not return; interrupt R to stop the application (usually by pressing Ctrl+C or Esc).

### Usage

    runApp(appDir = getwd(), port = getOption("shiny.port"),
      launch.browser = getOption("shiny.launch.browser", interactive()),
      host = getOption("shiny.host", "127.0.0.1"), workerId = "",
      quiet = FALSE, display.mode = c("auto", "normal", "showcase"),
      test.mode = getOption("shiny.testmode", FALSE))

### Arguments

`appDir`

The application to run. Should be one of the following:

- A directory containing `server.R`, plus, either `ui.R` or a `www` directory that contains the file `index.html`.

- A directory containing `app.R`.

- An `.R` file containing a Shiny application, ending with an expression that produces a Shiny app object.

- A list with `ui` and `server` components.

- A Shiny app object created by `shinyApp`.

`port` | The TCP port that the application should listen on. If the `port` is not specified, and the `shiny.port` option is set (with `options(shiny.port = XX)`), then that port will be used. Otherwise, use a random port.
`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. This value of this parameter can also be a function to call with the application's URL.
`host` | The IPv4 address that the application should listen on. Defaults to the `shiny.host` option, if set, or `"127.0.0.1"` if not. See Details.
`workerId` | Can generally be ignored. Exists to help some editions of Shiny Server Pro route requests to the correct process.
`quiet` | Should Shiny status messages be shown? Defaults to FALSE.
`display.mode` | The mode in which to display the application. If set to the value `"showcase"`, shows application code and metadata from a `DESCRIPTION` file in the application directory alongside the application. If set to `"normal"`, displays the application normally. Defaults to `"auto"`, which displays the application in the mode given in its `DESCRIPTION` file, if any.
`test.mode` | Should the application be launched in test mode? This is only used for recording or running automated tests. Defaults to the `shiny.testmode` option, or FALSE if the option is not set.

### Details

The host parameter was introduced in Shiny 0.9.0. Its default value of `"127.0.0.1"` means that, contrary to previous versions of Shiny, only the current machine can access locally hosted Shiny apps. To allow other clients to connect, use the value `"0.0.0.0"` instead (which was the value that was hard-coded into Shiny in 0.8.0 and earlier).

### Examples

    ## Not run:
    # Start app in the current working directory
    runApp()

    # Start app in a subdirectory called myapp
    runApp("myapp")

    ## End(Not run)

    ## Only run this example in interactive R sessions
    if (interactive()) {
      options(device.ask.default = FALSE)

      # Apps can be run without a server.r and ui.r file
      runApp(list(
        ui = bootstrapPage(
          numericInput('n', 'Number of obs', 100),
          plotOutput('plot')
        ),
        server = function(input, output) {
          output$plot <- renderPlot({ hist(runif(input$n)) })
        }
      ))

      # Running a Shiny app object
      app <- shinyApp(
        ui = bootstrapPage(
          numericInput('n', 'Number of obs', 100),
          plotOutput('plot')
        ),
        server = function(input, output) {
          output$plot <- renderPlot({ hist(runif(input$n)) })
        }
      )
      runApp(app)
    }

[Package shiny version 1.0.5 Index]