Overview
Framework for Stata
Structured research projects in Stata
Install
net install framework, from("https://raw.githubusercontent.com/frameworktools/framework-stata/main") replace
Read Installation for the requirements and setup. The source is on GitHub.
Getting started
- Installation
- Requirements, package installation, and setup check
- Quick start
- A project, a named dataset, a model, and a published result
- Support status
- Stata features, backend features, and untested areas
Features
- Projects and settings
- Finding the project, folder globals, settings files, and environments
- Data and integrity
- Named datasets, checksums, locked data, and the integrity ledger
- Publishing
- Destinations, folder bundles, Framework Cloud, and private paths
- Estimation results
- Models from regress, logit, mixed, stcox, and other commands
- Framework Cloud
- Computer login, project tokens, and token storage
- Backends
- The fw command-line tool and framework-py for GitHub Pages and S3
Reference
- Workflow
- Setup checks and project discovery
- Data
- Named datasets and integrity checks
- Publishing
- Files and estimation results
- Cloud
- Framework Cloud login and logout