configure_data: Configure Data Source

In framework: Structured Data Science Project Scaffolding

Configure Data Source

Description

Interactively add a data source to settings.yml (or settings.yml for legacy projects). Data sources are defined with dot-notation paths (e.g., "source.private.survey") and include metadata like file path, type, and whether the data is locked.

Usage

configure_data(
  path = NULL,
  file = NULL,
  type = NULL,
  locked = FALSE,
  interactive = TRUE
)

Arguments

path	Character. Dot-notation path for the data source (e.g., "source.private.survey")
file	Character. File path to the data file
type	Character. Data type: "csv", "tsv", "rds", "excel", "stata", "spss", "sas", or "auto"
locked	Logical. If TRUE, file is read-only and errors on changes
interactive	Logical. If TRUE, prompts for missing values. Default TRUE.

Value

Invisibly returns updated config

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