|
| 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