Framework for R

How to install Framework

Configure Framework defaults using the GUI

Framework conventions and project organization

Understanding the settings.yml configuration file

Create a new Framework project

Understanding the different project types in Framework

Full-featured project with organized data, work, and output directories

Enhanced privacy controls with separate private/public flows

Simplified structure for teaching materials

Minimal structure for slides and presentations

Initialize your project environment

A lightweight SQLite utility database to help manage your project and ensure data integrity

Managing R packages in Framework projects

Managing data files with the declarative data catalog

Organizing reusable functions in Framework projects

Customizing notebook, script, and project templates

How Framework integrates with Quarto for notebooks and presentations

Browse your work interactively with view() and the GUI

Save outputs with automatic tracking to framework.db

Version control and git hooks in Framework

Configuring AI coding assistants in Framework projects

Caching expensive computations for faster iteration

Connecting to databases and object storage providers

Querying databases with Framework helpers

Managing environment variables, secrets, and R session state

Publishing notebooks, data, and files to S3 storage

Setting up and managing the working environment

Reading, writing, and managing data files

Package management and renv integration

Saving figures, tables, reports, and models

Creating notebooks, scripts, and presentations

Creating and managing projects

Publishing outputs and reports

Git commands and hook management

Caching computed values for performance

Database connections and queries

AI assistant integration