Framework for R

Workflow

gui()

Launch Framework GUI

Opens a beautiful web-based interface for Framework with documentation, project management, and settings configuration.

Usage

gui(port = 8080, host = "127.0.0.1", browse = TRUE, route = NULL)

Arguments

Name Description
port

Port number to use (default: 8080)

host

Host address to bind to. Default "127.0.0.1" for local access only. Use "0.0.0.0" to allow connections from other machines (requires appropriate network security).

browse

Automatically open browser (default: TRUE)

route

Initial route to open (default: NULL for home page)

Value

Invisibly returns the plumber server object

Examples

if (FALSE) {
# Launch the GUI
framework::gui()
# Launch on specific port
framework::gui(port = 8888)
# Open directly to settings
framework::gui(route = "#/settings/basics")
# Run as standalone server (no browser, accessible from network)
framework::gui(port = 8080, host = "0.0.0.0", browse = FALSE)
}

See also