Overview

The Standard Project is Framework's default and most versatile project structure. It's designed for data analysis, research, and reporting workflows.

Directory Structure

An example project might look like:

my-project/
├── functions/           # Custom R functions (auto-loaded)
│   └── helpers.R
├── inputs/              # Data inputs
│   ├── raw/             # Original data (never modify)
│   ├── intermediate/    # Cleaned/processed data
│   └── final/           # Analysis-ready datasets
├── notebooks/           # Analysis notebooks
│   ├── 01-exploration.qmd
│   └── 02-modeling.qmd
├── outputs/
│   └── notebooks/       # Rendered notebooks
├── scripts/             # Automation scripts
│   └── data-pipeline.R
├── framework.db         # Metadata database
└── settings.yml         # Project configuration

Additional directories are created on first use:

• outputs/cache - Cached computations
• outputs/tables - Saved tables
• outputs/figures - Saved figures

Workflow

1. Set Up Environment

Start each session by running scaffold:

library(framework)
scaffold()

This loads:

• Required packages from settings.yml
• Custom functions from functions/
• Project configuration

2. Create Notebooks

Create analysis notebooks:

make_notebook("exploration")
make_notebook("modeling", subdir = "analysis")

3. Manage Data

Define data in settings.yml:

data:
  inputs.raw.sales:
    path: inputs/raw/sales_2024.csv
    type: csv

Load and process:

sales <- data_read("inputs.raw.sales")

4. Cache Results

Cache expensive computations:

model_results <- cache_remember("sales_model", {
  fit_complex_model(sales)
})

Best Practices

Organize Notebooks

Number notebooks to indicate order:

notebooks/
├── 01-data-import.qmd
├── 02-cleaning.qmd
├── 03-exploration.qmd
├── 04-modeling.qmd
└── 05-reporting.qmd

Use Subdirectories

For complex projects:

make_notebook("eda", subdir = "exploration")
make_notebook("regression", subdir = "modeling")

Separate Raw from Processed

Never modify raw data:

inputs/
├── raw/          # NEVER modify
├── intermediate/ # Cleaned versions
└── final/        # Ready for analysis