Framework for R

Workflow

load_settings_catalog()

Read the Framework settings catalog

The catalog defines metadata (labels, hints) and default values for settings sections. Users can override the packaged defaults by placing a settings-catalog.yml file in their Framework config directory (tools::R_user_dir("framework", "config")). When an override exists it is merged on top of the packaged catalog.

Usage

load_settings_catalog(include_user = TRUE, validate = TRUE)

Arguments

Name Description
include_user

Logical indicating whether to merge user overrides. Defaults to TRUE.

validate

Logical indicating whether to perform basic validation on the catalog structure. Defaults to TRUE.

Value

A nested list representing the settings catalog.