configure_directories: Configure Project Directories

In framework: Structured Data Science Project Scaffolding

Configure Project Directories

Description

Interactively configure project directory structure in settings.yml (or settings.yml for legacy projects). Directories control where Framework creates and looks for files.

Usage

configure_directories(directory = NULL, path = NULL, interactive = TRUE)

Arguments

directory	Character. Directory name to configure (e.g., "notebooks", "scripts")
path	Character. Path for the directory
interactive	Logical. If TRUE, prompts for missing values. Default TRUE.

Details

Standard Directories

• notebooks - Where make_notebook() creates files

• scripts - Where make_script() creates files

• functions - Where scaffold() looks for custom functions

• inputs_raw - Source data (gitignored)

• inputs_intermediate - Cleaned-but-input datasets

• inputs_final - Curated analytic datasets

• inputs_reference - External documentation/codebooks

• outputs_private - Working artifacts (tables/figures/models)

• outputs_public - Share-ready artifacts

• outputs_docs - Narrative/report outputs (private)

• outputs_docs_public - Narrative/report outputs (public)

• cache - Cached computation results

• scratch - Temporary workspace

Value

Invisibly returns updated config

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