Saving Work

Overview

Framework provides a unified system for saving your work. When you save tables, figures, models, reports, or notebooks, they're automatically logged to framework.db with metadata for easy retrieval later.

Saving Outputs

Tables

Save data frames in various formats:

# CSV (default)
save_table(results, "analysis_results")

# Other formats
save_table(results, "analysis_results", format = "rds")
save_table(results, "analysis_results", format = "parquet")
save_table(results, "analysis_results", format = "xlsx")

# Public output (for sensitive projects)
save_table(summary_stats, "public_summary", public = TRUE)

Figures

Save ggplot2 or base R graphics:

# Basic save
save_figure(my_plot, "revenue_chart")

# With dimensions
save_figure(my_plot, "revenue_chart", width = 10, height = 6, dpi = 300)

# Different formats
save_figure(my_plot, "revenue_chart", format = "pdf")
save_figure(my_plot, "revenue_chart", format = "svg")

Models

Save fitted model objects:

# Save a model
model <- lm(y ~ x, data = df)
save_model(model, "regression_v1")

# Save with specific format
save_model(model, "regression_v1", format = "rds")

Reports & Notebooks

Save rendered documents:

# Copy a rendered report to outputs
save_report("outputs/analysis.html", "quarterly_report")

# Move instead of copy
save_report("outputs/analysis.html", "quarterly_report", move = TRUE)

# Render and save a Quarto notebook
save_notebook("notebooks/analysis.qmd", "final_analysis")

Automatic Tracking

Every save_* function automatically logs to the results table in framework.db:

Field	Description
name	The name you provided
type	Output type (table, figure, model, report, notebook)
public	Whether saved to public or private directory
hash	File integrity hash
created_at	When first saved
updated_at	When last modified

No extra steps needed—tracking happens automatically.

Public vs Private Outputs

For Privacy Sensitive projects, the public parameter controls output location:

# Private (default) - goes to outputs/private/tables/
save_table(detailed_results, "patient_outcomes")

# Public - goes to outputs/public/tables/
save_table(aggregated_stats, "summary", public = TRUE)

Private outputs are gitignored; public outputs can be shared and committed.

For Standard projects, the public parameter still works but outputs go to a single outputs/ directory structure.

Output Directories

Framework organizes outputs by type:

outputs/
├── tables/           # save_table() output
├── figures/          # save_figure() output
├── models/           # save_model() output
├── reports/          # save_report() output
└── notebooks/        # save_notebook() output

For Privacy Sensitive projects:

outputs/
├── private/
│   ├── tables/
│   ├── figures/
│   └── ...
└── public/
    ├── tables/
    ├── figures/
    └── ...

---