runBackgroundApp: Run Shiny App in a Background Process

In TileDB-Inc/shinybg: Shiny applications in the background

Run Shiny App in a Background Process

Description

Run Shiny App in a Background Process

Usage

runBackgroundApp(
  ui = NULL,
  server = NULL,
  appFile = NULL,
  appDir = NULL,
  port = getOption("shiny.port"),
  host = getOption("shiny.host", "127.0.0.1"),
  stdout = "|",
  stderr = "|"
)

Arguments

ui	The UI definition of the app.
server	A function with three parameters: input, output, and session. The function is called once for each session ensuring that each app is independent.
appFile	Path to a .R file containing a Shiny application
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 (defaults to 3000).
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.
stdout	The name of the file the standard output of the child R process will be written to. If the child process runs with the --slave option (the default), then the commands are not echoed and will not be shown in the standard output. Also note that you need to call print() explicitly to show the output of the command(s). IF NULL (the default), then standard output is not returned, but it is recorded and included in the error object if an error happens.
stderr	The name of the file the standard error of the child R process will be written to. In particular message() sends output to the standard error. If nothing was sent to the standard error, then this file will be empty. This argument can be the same file as stdout, in which case they will be correctly interleaved. If this is the string "2>&1", then standard error is redirected to standard output. IF NULL (the default), then standard output is not returned, but it is recorded and included in the error object if an error happens.

Value

A callr::r_process object for the background Shiny app

Examples

## Not run: 
app <- system.file("apps/sever-info-app.R", package = "shinybg")
bg_app <- runBackgroundApp(appFile = app, port = 3005)
bg_app$kill()

## End(Not run)

TileDB-Inc/shinybg documentation built on March 10, 2023, 3:14 p.m.