framework docs
Data

data_info()

Get data specification from config

Gets the data specification for a given dot notation path from settings.yml. Supports dot notation (e.g., "source.private.example"), relative paths, and absolute paths. Auto-detects file type from extension and applies intelligent defaults for common formats.

Usage

data_info(path)

Arguments

path
Dot notation path (e.g. "source.private.example"), relative path, or absolute path to a data file

Value

A list with data specification including: - `path` - Full file path - `type` - File type (csv, rds, stata, spss, sas, etc.) - `delimiter` - Delimiter for CSV files (comma, tab, etc.) - `locked` - Whether file is locked for integrity checking - `private` - Whether file is in private data directory - `description` - Optional description of the dataset (displayed when loading)

Examples

if (FALSE) {
# Get info from dot notation
info <- data_info("source.private.my_data")
# Get info from file path
info <- data_info("data/public/example.csv")
}