settings: Get settings value by dot-notation key

In framework: Structured Data Science Project Scaffolding

Get settings value by dot-notation key

Description

Framework's primary configuration helper that supports both flat and hierarchical key access using dot notation. Automatically checks common locations for directory settings. Pretty-prints nested structures in interactive sessions.

Usage

settings(key = NULL, default = NULL, settings_file = NULL)

Arguments

key	Character. Dot-notation key path (e.g., "notebooks" or "directories.notebooks" or "connections.db.host"). If NULL, returns entire settings.
default	Optional default value if key is not found (default: NULL)
settings_file	Settings file path (default: checks "settings.yml" then "settings.yml")

Details

For directory settings, the function checks multiple locations:

• Direct: settings("notebooks") checks directories$notebooks, then options$notebook_dir

• Explicit: settings("directories.notebooks") checks only directories$notebooks

File Discovery:

• Checks settings.yml first (Framework's preferred convention)

• Falls back to settings.yml if settings.yml not found

• You can override with explicit settings_file parameter

Output Behavior:

• Interactive sessions: Pretty-prints nested lists/structures and returns invisibly

• Non-interactive (scripts): Returns raw value without printing

• Simple values: Always returned directly without modification

Value

The settings value, or default if not found. In interactive sessions, nested structures are pretty-printed and returned invisibly.

Examples

if (FALSE) {
# Get notebook directory (checks both locations)
settings("notebooks")

# Get explicit nested setting
settings("directories.notebooks")
settings("connections.db.host")

# Get entire section
settings("directories")  # Returns all directory settings
settings("connections")  # Returns all connection settings

# View entire settings
settings()  # Returns full configuration

# With default value
settings("missing_key", default = "fallback")
}

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