Skip to content

Commit cfd72e9

Browse files
committed
Add root CLAUDE.md as navigation hub
- Points to both R (legacy) and Python (active) projects - Links to detailed Python documentation in a4d-python/docs/ - Warns about shared reference_data/ used by both - Ensures AI assistance can find guidance at repository root
1 parent d3c758b commit cfd72e9

1 file changed

Lines changed: 59 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# CLAUDE.md
2+
3+
This repository contains **two projects**:
4+
5+
## 1. R Pipeline (Production - Legacy)
6+
7+
**Location**: Root directory
8+
**Status**: Production (being phased out)
9+
10+
The original R implementation of the A4D medical tracker data processing pipeline.
11+
12+
**Key Files**:
13+
- `R/` - R package code
14+
- `scripts/R/` - Pipeline scripts
15+
- `reference_data/` - Shared YAML configurations
16+
17+
**Commands**: See README.md for R-specific commands
18+
19+
---
20+
21+
## 2. Python Pipeline (Active Development)
22+
23+
**Location**: `a4d-python/`
24+
**Status**: Active migration
25+
**Branch**: `migration`
26+
27+
New Python implementation with better performance and incremental processing.
28+
29+
**Documentation**: [a4d-python/docs/CLAUDE.md](a4d-python/docs/CLAUDE.md)
30+
31+
**Quick Start**:
32+
```bash
33+
cd a4d-python
34+
uv sync
35+
uv run pytest
36+
```
37+
38+
**Migration Guide**: [a4d-python/docs/migration/MIGRATION_GUIDE.md](a4d-python/docs/migration/MIGRATION_GUIDE.md)
39+
40+
---
41+
42+
## Working on This Repository
43+
44+
**If working on R code**: Stay in root, use R commands
45+
46+
**If working on Python migration**:
47+
```bash
48+
cd a4d-python
49+
# See a4d-python/docs/CLAUDE.md for Python-specific guidance
50+
```
51+
52+
## Shared Resources
53+
54+
Both projects use the same reference data:
55+
- `reference_data/synonyms/` - Column name mappings
56+
- `reference_data/data_cleaning.yaml` - Validation rules
57+
- `reference_data/provinces/` - Allowed provinces
58+
59+
**Do not modify these** without testing both R and Python pipelines.

0 commit comments

Comments
 (0)