load_settings_catalog: Read the Framework settings catalog
In framework: Structured Data Science Project Scaffolding
View source: R/settings_catalog.R
load_settings_catalog R Documentation
Read the Framework settings catalog
Description
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
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.
framework documentation built on Feb. 18, 2026, 1:07 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/settings_catalog.R
| load_settings_catalog | R Documentation |
Read the Framework settings catalog
Description
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
include_user |
Logical indicating whether to merge user overrides.
Defaults to |
validate |
Logical indicating whether to perform basic validation on
the catalog structure. Defaults to |
Value
A nested list representing the settings catalog.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.