setup: Setup Framework (First-Time Configuration)

In framework: Structured Data Science Project Scaffolding

Setup Framework (First-Time Configuration)

Description

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

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

Value

Invisibly returns the plumber server object

See Also

gui() for launching the GUI without initialization check

Examples

if (FALSE) {
# First-time setup
framework::setup()
}

framework documentation built on Feb. 18, 2026, 1:07 a.m.