Framework Framework

Getting Started

Installation Setup Conventions settings.yml framework.db New Project

Features

scaffold() Packages Data Management Functions Templates Quarto Integration Viewing Work Saving Work Git Integration AI Assistants Caching Connections Environment Publishing
API Reference Blog

Workflow

settings_read

Read project settings

Reads the project settings from settings.yml or config.yml with environment-aware merging and split file resolution. Auto-discovers the settings file if not specified.

Usage

settings_read(settings_file = NULL, environment = NULL)

Arguments

Argument Description
settings_file

Path to settings file (default: auto-discover settings.yml or config.yml)
environment

Active environment name (default: R_CONFIG_ACTIVE or "default")

Returns

The settings as a list

Source: R/config.R