Getting Started
Documentation
Welcome to the Framework documentation. Framework is a data management and project scaffolding system for reproducible data analysis workflows in R.
Quick Start
Install Framework from GitHub:
# Install remotes if needed
install.packages("remotes")
# Install Framework
remotes::install_github("erikwestlund/framework")Create a new project:
library(framework)
init()Getting Started
Installation
How to install Framework
Setup
Configure Framework defaults using the GUI
Conventions
Framework conventions and project organization
settings.yml
Understanding the settings.yml configuration file
Making a New Project
Create a new Framework project
Core Concepts
Understand the key concepts that power Framework:
Project Types
Framework supports different project types for different workflows:
Project Types Overview
Understanding the different project types in Framework
Standard Project
Full-featured project with organized data, work, and output directories
Privacy Sensitive Project
Enhanced privacy controls with separate private/public flows
Course/Teaching
Simplified structure for teaching materials
Presentation
Minimal structure for slides and presentations
API Reference
Explore Framework's complete API by category:
| Category | Description |
|---|---|
| Workflow | Setting up and managing the working environment |
| Data | Reading, writing, and managing data files |
| Packages | Package management and renv integration |
| Saving Work | Saving figures, tables, reports, and models |
| Notebooks & Scripts | Creating notebooks, scripts, and presentations |
| Project Management | Creating and managing projects |
| Publishing | Publishing outputs and reports |
| Git | Git commands and hook management |
| Caching | Caching computed values for performance |
| Database | Database connections and queries |
| AI | AI assistant integration |