Skip to content

Commit 8e874f1

Browse files
committed
Create data_flow.md
1 parent 48d7b15 commit 8e874f1

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

data_flow.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Data Flow Documentation
2+
3+
This file explains the typical flow of data through the InsightStack toolkit.
4+
5+
📊 ![InsightStack Flow Diagram](./docs/InsightStack_data_flow_diagram_clean.png)
6+
7+
---
8+
9+
## 🔄 Typical Workflow
10+
11+
1. **Raw Data Entry**
12+
- Source: XLSForms, field surveys, or CSV files
13+
- Tools: `survey_to_codebook/`, `data_validation/`
14+
15+
2. **Data Validation**
16+
- Scripts flag:
17+
- Missing values
18+
- Duplicates
19+
- Out-of-range values
20+
- Folder: `data_validation/`
21+
22+
3. **Variable Labeling**
23+
- Apply readable labels from a dictionary
24+
- Folder: `label_variables/`
25+
- Compatible across R, Python, and Stata
26+
27+
4. **Exploration & Analysis**
28+
- Summary stats, regressions, and model testing
29+
- Folder: `replication/`
30+
- Can use Stata, R, or Python
31+
32+
5. **Documentation**
33+
- Convert survey design into Markdown codebooks
34+
- Folder: `survey_to_codebook/`
35+
36+
6. **Archival & Replication**
37+
- Reusable scripts, testable results, and cleaned data
38+
- Folder: `replication/`, with output storage
39+
40+
---
41+
42+
Each folder in InsightStack corresponds to one or more of these steps — allowing any user to jump in, adapt, or expand the workflow for their own context.

0 commit comments

Comments
 (0)