Workflow

setup

Setup Framework (First-Time Configuration)

Initializes Framework's global configuration and launches the GUI for first-time setup. This is the recommended entry point for new users.


Usage

setup(port = 8080, browse = TRUE)

Arguments

Argument Description
port

Port number to use (default: 8080)

browse

Automatically open browser (default: TRUE)

Details

Use this function after installing Framework to:

  • Set your author name and email
  • Configure default packages for new projects
  • Set IDE preferences (VS Code, RStudio)
  • Configure other global defaults

Returns

Invisibly returns the plumber server object

Examples

# First-time setup
framework::setup()

See Also

Source: R/gui.R