Skip to content

Commit be7cc5f

Browse files
committed
bringing the full-run json schema with versioning into the repo
1 parent cf9f713 commit be7cc5f

File tree

4 files changed

+749
-0
lines changed

4 files changed

+749
-0
lines changed

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,13 @@
134134
!/globus/scripts/*.sh
135135
!/globus/scripts/*.py
136136

137+
# JSON report schemas
138+
!/schemas
139+
!/schemas/current
140+
!/schemas/v*
141+
!/schemas/v*/*.json
142+
!/schemas/v*/*.md
143+
137144
# testing
138145
!/tests
139146
!/tests/data

schemas/current

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v0.1.0-alpha

schemas/v0.1.0-alpha/CHANGELOG.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Schema Changelog
2+
3+
## v0.1.0-alpha (Initial Alpha)
4+
5+
Initial schema version for OneRoof reporting. Alpha version indicates
6+
the schema is experimental and breaking changes should be expected.
7+
8+
### Top-level Structure
9+
10+
- `schema_version`: Version string (e.g., "0.1.0-alpha")
11+
- `generated_at`: ISO 8601 timestamp
12+
- `run_metadata`: Pipeline run configuration and metadata
13+
- `summary`: Aggregate statistics across all samples
14+
- `samples`: Per-sample metrics keyed by sample_id
15+
16+
### Sample Metrics
17+
18+
Each sample includes:
19+
20+
- `sample_id`: Unique identifier
21+
- `qc_status`: One of "pass", "warn", "fail"
22+
- `qc_notes`: Human-readable QC issue descriptions
23+
- `alignment`: Read mapping statistics
24+
- `variants`: Variant calling results (optional)
25+
- `consensus`: Consensus sequence metrics (optional)
26+
- `metagenomics`: Sylph profiling results (optional)
27+
- `haplotyping`: Devider haplotype phasing results (optional, Nanopore only)
28+
29+
### QC Thresholds (defaults)
30+
31+
- Coverage: pass ≥95%, warn ≥80%, fail <80% genome at ≥10x
32+
- Completeness: pass ≥98%, warn ≥90%, fail <90%
33+
- N percentage: pass <1%, warn <5%, fail ≥5%
34+
- Mapped reads: pass ≥1000, warn ≥100, fail <100

0 commit comments

Comments
 (0)