Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
62 commits
Select commit Hold shift + click to select a range
3073c74
fix(acmg): count the copies of a recessive gene hit, not the alt copi…
GeiserX Nov 19, 2026
0d3893b
fix(two-hits): a homozygous hypomorph inside a deletion is only possi…
GeiserX Nov 19, 2026
286b476
fix(carrier): keep the combined-allele note, and pair no record witho…
GeiserX Nov 19, 2026
3c9d565
docs(acmg): state the haplotype rule in the four places it lives, and…
GeiserX Nov 19, 2026
1100d0b
fix(bloodtype): mark calls under GQ 20 or DP 8 as weak and keep their…
GeiserX Nov 19, 2026
017ef87
fix(bloodtype): lower confidence for weak calls and stop reading a mi…
GeiserX Nov 19, 2026
4a5da3f
docs(bloodtype): say what a weak call, a missing record and phase do,…
GeiserX Nov 19, 2026
262a4c0
fix(bloodtype): read a gVCF block that reaches a marker through END a…
GeiserX Nov 19, 2026
678520c
test(acmg): a run without step 23 must get the secondary-findings card
GeiserX Nov 20, 2026
b625fd2
feat(acmg): write the secondary-findings card as its own section from…
GeiserX Nov 20, 2026
f77cc34
docs(acmg): say where the secondary-findings card lives, and check it…
GeiserX Nov 20, 2026
1048f98
style(acmg): cargo fmt
GeiserX Nov 20, 2026
2c9e3ec
test(e2e): keep the platelet and copy-number cases true with not asse…
GeiserX Nov 20, 2026
54d65da
test(render): expect the TAR pair as possibly biallelic
GeiserX Nov 20, 2026
856996f
Merge origin/main into pgp/screen-acmg-card-section
GeiserX Nov 20, 2026
0ef7789
Merge remote-tracking branch 'origin/main' into pgp/i411-bloodtype-ca…
GeiserX Nov 20, 2026
8e2025d
fix(telomere): pass the shipped GRCh38 bands in both mirrors, never hg19
GeiserX Nov 20, 2026
db50aaf
build(telomere): move step 10 to TelomereHunter2 1.0.12
GeiserX Nov 20, 2026
cd72dd1
docs(telomere): describe tel_content as relative, never an age
GeiserX Nov 20, 2026
22f6680
fix(bloodtype): name a weak c.1061delC call and keep the Bombay note …
GeiserX Nov 20, 2026
8e9d9e8
fix(acmg): name a clinical VCF of an earlier run in the secondary-fin…
GeiserX Nov 20, 2026
fa18468
fix(report): map the acmg_sf section to the clinical-filter frame and…
GeiserX Nov 20, 2026
9fe3ece
fix(report): show acmg_sf with the clinical section so the HTML frame…
GeiserX Nov 20, 2026
4321a19
docs(acmg): say when each summary card is there and when the two differ
GeiserX Nov 20, 2026
c33ddd6
Merge #509 i411-prs-variant-only into the T7 batch tip
GeiserX Nov 20, 2026
6ea1012
Merge #531 i411-sf-haplotype-count into the T7 batch tip
GeiserX Nov 20, 2026
3701fa3
Merge #532 i411-bloodtype-call-floor into the T7 batch tip
GeiserX Nov 20, 2026
7aa1130
Merge #533 screen-acmg-card-section into the T7 batch tip
GeiserX Nov 20, 2026
c9961b9
fix(ci): let a HIGH-impact row change the gene's pair in the ACMG car…
GeiserX Nov 20, 2026
912466d
test(mito): a shifted poly-C indel and a NuMT filter without depth mu…
GeiserX Nov 20, 2026
48505ed
fix(pgx): require 10x in the CYP2D6 flanks before the depth check passes
GeiserX Nov 20, 2026
d9ad330
fix(pgx): flag weak pypgx evidence in the step 36 consensus table
GeiserX Nov 20, 2026
7e6654e
docs(pgx): say the CYP2D6 depth check needs 10x flanks and how weak p…
GeiserX Nov 20, 2026
102771b
fix(mito): match a chrM indel at the left end of its repeat, and name…
GeiserX Nov 20, 2026
df8550b
fix(mito): warn and flag the table when the NuMT filter has no autoso…
GeiserX Nov 20, 2026
f74af7a
docs(mito): say how indels are matched and what the numt line means
GeiserX Nov 20, 2026
10ad32d
refactor(report): build the five chart specs and their SVG in og-render
GeiserX Nov 20, 2026
29e8d44
test(report): move the chart checks to cargo
GeiserX Nov 20, 2026
74d0b7f
docs(changelog): og report charts
GeiserX Nov 20, 2026
4633372
feat(run): EVERYTHING=true runs every optional step, TIDDIT=true runs…
GeiserX Nov 20, 2026
fa14376
feat(dev): og dev everything-check keeps assets/everything.tsv complete
GeiserX Nov 20, 2026
9f9174d
test(run): fake-docker case for EVERYTHING=true
GeiserX Nov 20, 2026
87fc304
docs(run): say what EVERYTHING=true and -profile everything run
GeiserX Nov 20, 2026
02a122c
feat(viewer): port the local genome viewer to og view serve
GeiserX Nov 20, 2026
6f8d165
fix(viewer): start the local viewer with og and open Manta's SVs first
GeiserX Nov 20, 2026
30427c8
docs(viewer): say the viewer runs on og, refuses forwarded requests a…
GeiserX Nov 20, 2026
da09f8e
fix(ci): give the summary-collect goldens' acmg_sf card the fields #5…
GeiserX Nov 20, 2026
b4134ad
fix(ci): apply the ACMG card's HIGH-impact pair rule in the e2e check…
GeiserX Nov 20, 2026
6231025
fix(mito): warn on the Nextflow console when the NuMT filter has no d…
GeiserX Nov 20, 2026
66e89ee
fix(viewer): write the request log from the thread that owns stderr, …
GeiserX Nov 20, 2026
497aecb
test(report): keep the HTML report's chart checks until og embeds the…
GeiserX Nov 20, 2026
660310a
fix(mito): check an indel's whole REF against the rCRS before moving it
GeiserX Nov 20, 2026
c3a3c78
fix(run): EVERYTHING=true stops before Nextflow without GRIDSS's BWA …
GeiserX Nov 20, 2026
b9418a5
Merge #534 i411-telomere-bands into the T8 batch tip
GeiserX Nov 20, 2026
176ea2c
Merge origin/main (T6 landing 4ee60e6a) into the T8 batch tip
GeiserX Nov 20, 2026
3917166
Merge #535 i411-cyp2d6-gate into the T8 batch tip
GeiserX Nov 20, 2026
84a97e1
Merge #536 i411-mito-annotate into the T8 batch tip
GeiserX Nov 20, 2026
49632af
Merge #537 port-report-charts into the T8 batch tip
GeiserX Nov 20, 2026
79341f0
Merge #538 screen-everything-switch into the T8 batch tip
GeiserX Nov 20, 2026
27793f9
test(live): compare the gate transparency renders whatever order thei…
GeiserX Nov 20, 2026
9b57a52
test(parity): hold og report charts to render_report.py on all 154 co…
GeiserX Nov 20, 2026
0d88e39
docs(rust): og report charts is ported, no longer a stub
GeiserX Nov 20, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/workflows/guard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -945,6 +945,14 @@ jobs:
working-directory: .
run: bin/og dev remnants

# EVERYTHING=true and -profile everything run every optional step from
# assets/everything.tsv: a new tool, switch, setup flag, false-by-default
# or opt-in parameter, or optional image with no row there fails here.
# Its planted cases are og-dev's everything::tests, in cargo test.
- name: og dev everything-check
working-directory: .
run: bin/og dev everything-check

# main.nf runs the same check before any task: a stale og stops
# `nextflow run` with the setup command. Without the check, this stub
# run completes and the step fails.
Expand Down
14 changes: 14 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

24 changes: 16 additions & 8 deletions assets/acmg_sf.tsv
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# acmg_sf.tsv: the ACMG SF v3.3 secondary-findings genes and the reporting rule of each
# (bin/collect_summary.py acmg_sf_tier). One row per gene, 84 rows. Source: Lee et al., ACMG SF v3.3
# (og summary collect, rust/crates/og-summary/src/collect/acmg.rs). One row per gene, 84 rows.
# Source: Lee et al., ACMG SF v3.3
# list for reporting of secondary findings in clinical exome and genome sequencing, Genet Med
# 2025;27(8):101454 (PMID 40568962, doi:10.1016/j.gim.2025.101454), Table 1 and its footnotes, read
# 2026-10-27. HGNC ids from rest.genenames.org on 2026-10-27; GRCh38 positions from Ensembl.
Expand All @@ -8,14 +9,21 @@
# inheritance AD, AR, SD (semidominant) or XL, as Table 1 gives it
# report_if when a P/LP variant (ClinVar, or a rare HIGH-impact record) is a secondary finding:
# any one variant is enough
# biallelic two variants: a homozygote, or two different variants even when
# their phase is unknown (Table 1 footnote a); a called deletion
# of the gene (AnnotSV, step 35's copy number) counts as one of the
# two unless read-backed phase puts it on the variant's copy
# (bin/collect_summary.py two_hits); so it does for hemizygous
# biallelic both copies of the gene hit: a homozygote, or two different
# variants even when their phase is unknown (Table 1 footnote a;
# reported as possibly biallelic). Two variants that read-backed
# phase puts on one copy (a "|" GT and the same PS) are one copy
# and are not reported; a "|" GT with no PS, or a half call such
# as 1|., is phase unknown. A combined allele of step 06 counts
# once with its parts, and a record with no alt copy called counts
# nothing. A called deletion of the gene (AnnotSV, step 35's copy
# number) counts as one of the two unless read-backed phase puts
# it on the variant's copy (og-summary two_hits); so it does for
# hemizygous
# hom_variant only a variant of the variants column, homozygous
# hemizygous a hemizygous or homozygous variant, or two heterozygous ones; a
# single heterozygous variant is not reported
# hemizygous a hemizygous or homozygous variant, or two heterozygous ones
# counted as for biallelic; a single heterozygous variant is not
# reported
# het_female_too any variant, heterozygous females included
# variants report_if hom_variant: the only variants that count, as chrom:pos:ref:alt (GRCh38)
# and a name; "." for every other gene
Expand Down
159 changes: 159 additions & 0 deletions assets/everything.tsv
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
# assets/everything.tsv: every optional part of a run, and what EVERYTHING=true (scripts/run-all.sh) and
# -profile everything (conf/everything.config) do with it. One row per item; `og dev everything-check` fails when
# main.nf, nextflow.config, run-all.sh, setup.sh or versions.env gains an item with no row here.
# kind: tool (a main.nf --tools name: EVERYTHING names it), switch (a run-all.sh switch: EVERYTHING sets it to
# value), setup (a setup.sh flag: value names the rows whose data it installs), input (a choice or a file only
# the user can give: EVERYTHING leaves it to them), image (an optional image of versions.env: value names the row
# whose step runs it), excluded (left out: reason says why).
# value: tool and input rows: how to install the data, '-' when none is needed; switch rows: the value EVERYTHING
# sets; setup and image rows: the rows they serve, comma separated.
# nextflow: switch rows with a Nextflow parameter: that parameter as conf/everything.config sets it, else '-'.
# Rows named --<param> stand for a Nextflow parameter that has no run-all.sh switch.
kind name value nextflow reason
tool pharmcat - - step 07
tool cpic - - step 27
tool clinvar setup.sh - step 06
tool pypgx the pypgx-bundle, by hand: docs/00-reference-setup.md - step 32
tool vep setup.sh --vep-cache - step 13
tool vcfanno setup.sh --vep-cache, then the score files of docs/00-reference-setup.md - step 30
tool slivar setup.sh --vep-cache - step 31
tool clinical_filter setup.sh --vep-cache - step 23
tool cpsr setup.sh --clinical-data - step 17
tool roh - - step 11
tool prs setup.sh - step 25
tool ancestry setup.sh --ancestry-panel - step 26
tool ancestry_fine setup.sh --ancestry-fine-panel - step 26b
tool mito_haplogroup - - step 12
tool hla_typing setup.sh - step 08
tool expansion_hunter - - step 09
tool stranger - - step 9b
tool telomere_hunter - - step 10
tool mosdepth - - step 16b
tool mito_variants - - step 20
tool cyrius setup.sh --cyrius - step 21; its licence is non-commercial, and installing it accepts that licence
tool manta - - step 04
tool delly - - step 19
tool cnvpytor the CNVpytor resources, by hand: docs/00-reference-setup.md - step 18
tool duphold - - step 15
tool annotsv setup.sh --annotsv-data - step 05
tool survivor_merge - - step 22
tool sample_qc setup.sh --sample-qc-data - step 33
tool parascopy setup.sh --parascopy-data - step 35
tool paraphase - - step 35b; a BAM that is not PacBio HiFi is skipped
tool y_haplogroup setup.sh --yleaf-data - step 37; a female sample is skipped
tool html_report - - step 24; run-all.sh writes the report itself after the pipeline
tool multiqc - - step 28
tool consumer_export setup.sh --consumer-sites - step 40
tool bloodtype - - step 41
tool lpa - - step 46
tool vntyper - - step 52
tool traits - - step 42
tool archaic setup.sh --archaic - step 43
tool ancient setup.sh --ancient-panel - step 44
tool y_str - - step 45; a female sample is skipped
tool viral setup.sh --viral-data - step 47
tool chip setup.sh --chip-data - step 49
tool mei setup.sh --megane-kmers - step 50
tool mocha setup.sh --mocha-data - step 51
tool locityper setup.sh --locityper-data - step 53
input exomiser setup.sh --exomiser-data - step 48 runs when HPO (or --hpo) names the symptoms; naming it without them stops the run
excluded cram_archive - - a CRAM copy of each BAM for the archive: it costs disk and adds no result
switch KIR true --kir true step 08 types the KIR genes too; setup.sh --kir-data
switch HLA_QC true --hla_qc true step 08 runs OptiType beside T1K
switch CPSR_SECONDARY_FINDINGS true --cpsr_secondary_findings true step 17 also screens the ACMG SF genes
switch GRIDSS true - script 04b after the pipeline
switch TIDDIT true - script 04a after the pipeline
switch IMPUTATION true - script 14 after the pipeline
switch SOMATIC true - script 29 after the pipeline
switch EXTRA_CALLERS gatk,freebayes,strelka2,octopus - scripts 03a to 03d after the pipeline
switch BENCHMARK true - benchmark-variants.sh after the extra callers
input HPO setup.sh --exomiser-data - the symptoms as HPO ids; only the user knows them
input FAMILIES - - who is related to whom; steps 38 and 39 run when the family has what they need
input ALIGN_DIR - - the BAM of another aligner (script 02a writes aligned_bwamem2/)
input REF_FASTA - - another GRCh38 build
input EH_CATALOG - - another catalog for steps 09 and 9b
input MANTA_CALL_REGIONS - - the regions Manta calls on
input PARASCOPY_POPULATION - - the Parascopy model; EUR when unset
input PARAPHASE_REGIONS - - the Paraphase regions; all when unset
input ANCESTRY_PANEL - - another panel for step 26; none skips the step, which EVERYTHING=true refuses
input ANCESTRY_FINE_DIR - - another panel for step 26b; none skips the step, which EVERYTHING=true refuses
input ARCHAIC_DIR - - another table for step 43; none skips the step, which EVERYTHING=true refuses
input ARCHAIC_POP - - the 1000 Genomes group of step 43; ALL when unset
input PGSC_CALC_DIR - - another pgsc_calc checkout
input ANCIENT_PANEL_DIR - - another panel for step 44
input VIRAL_REF - - other viral genomes for step 47
input MEGANE_KMERS - - another k-mer set for step 50
input MOCHA_DATA - - another panel for step 51
input LOCITYPER_DATA - - another database for step 53
input LOCITYPER_BG_REGION - - another background region for step 53
input long-read - - scripts 02b, 03e and 04c read ONT or PacBio HiFi reads: run them by hand on long-read data
input --pedigree - - the family file of the Nextflow path (FAMILIES on run-all.sh)
input --medications - - the drugs taken, for step 27's phenoconversion
excluded EVERYTHING - - this switch
excluded TOOLS - - EVERYTHING=true names every tool itself, so it refuses TOOLS
excluded GENOME_DIR - - where the data is, not a step
excluded SKIP_VALIDATION - - skips a check, not a step
excluded THREADS - - a resource cap, not a step
excluded SKIP_TRIM - - skips fastp, so it removes a step
excluded INTERVALS - - calls part of the genome, so it removes work
excluded OWNGENOME_LIVE_URL - - the live site's address, not a step
excluded NXF_VER - - the Nextflow release, not a step
excluded NXF_WORK - - Nextflow's work folder, not a step
excluded NXF_HOME - - Nextflow's home folder, not a step
excluded NXF_OFFLINE - - Nextflow's offline mode, not a step
excluded --allow_unfiltered - - accepts a VCF with no FILTER=PASS record: an input choice, not a step
excluded --skip_trim - - skips fastp, so it removes a step
excluded --prs_keep_ambiguous - - changes which rows of a score count, not which steps run
setup --cyrius cyrius - Cyrius, under its non-commercial licence
setup --parascopy-data parascopy - Parascopy's table and models
setup --kir-data KIR - IPD-KIR
setup --ancestry-panel ancestry - pgsc_calc's ancestry panel
setup --ancestry-fine-panel ancestry_fine - the fine-grained ancestry panel
setup --yleaf-data y_haplogroup - Yleaf's tables
setup --consumer-sites consumer_export - the 23andMe v5 site table
setup --ancient-panel ancient - the AADR panel
setup --viral-data viral - the viral genomes
setup --exomiser-data exomiser,HPO - Exomiser's data
setup --chip-data chip - Ensembl's gene annotation
setup --strchive-data expansion_hunter,stranger - the STRchive catalog; part of a full setup
setup --megane-kmers mei - MEGAnE's k-mer set
setup --mocha-data mocha - MoChA's panel
setup --locityper-data locityper - Locityper's database
setup --vep-cache vep,vcfanno,slivar,clinical_filter - the VEP cache; part of a full setup
setup --annotsv-data annotsv - AnnotSV's data; part of a full setup
setup --archaic archaic - the archaic table
setup --clinical-data cpsr,vep - the VEP caches and the CPSR bundle; part of a full setup
setup --sample-qc-data sample_qc - somalier's sites and VerifyBamID2's panel; part of a full setup
excluded --masked-reference - - another reference: every sample is aligned again on it
excluded --og - - builds og, which a full setup does too
excluded --no-clinical-data - - installs less
excluded --pull-only - - pulls the images only
excluded --refresh - - replaces ClinVar with a newer release
image BWAMEM2_IMAGE ALIGN_DIR - script 02a
image BWA_IMAGE GRIDSS - the classic BWA index of script 04b
image FREEBAYES_IMAGE EXTRA_CALLERS - script 03b
image STRELKA_IMAGE EXTRA_CALLERS - script 03c
image OCTOPUS_IMAGE EXTRA_CALLERS - script 03d
image CLAIR3_IMAGE long-read - script 03e
image TIDDIT_IMAGE TIDDIT - script 04a
image SNIFFLES_IMAGE long-read - script 04c
image HAPPY_IMAGE BENCHMARK - benchmark-variants.sh
image YLEAF_IMAGE y_haplogroup - step 37
image HIPSTR_IMAGE y_str - step 45
image OPTITYPE_IMAGE HLA_QC - step 08 with HLA_QC=true
image PARASCOPY_IMAGE parascopy - step 35
image PARAPHASE_IMAGE paraphase - step 35b
image MEGANE_IMAGE mei - step 50
image VNTYPER_IMAGE vntyper - step 52
image LOCITYPER_IMAGE locityper - step 53
image GLNEXUS_IMAGE FAMILIES - step 38
image HAP_IBD_IMAGE FAMILIES - step 38
image EXOMISER_IMAGE exomiser - step 48
image ADMIXTURE_IMAGE ancestry_fine - step 26b
image BEAGLE_IMAGE ancestry_fine,mocha - steps 26b and 51
image RFMIX_IMAGE ancestry_fine - step 26b
image BCFTOOLS_HTTPS_IMAGE --ancestry-fine-panel - setup.sh --ancestry-fine-panel
image MOCHA_IMAGE mocha - step 51
image IBDMIX_IMAGE archaic - step 43
image EIGENSOFT_IMAGE ancient - step 44
excluded SAMTOOLS_HTTPS_IMAGE - - docs/quick-test.md reads a CRAM over https with it; no step runs it
2 changes: 2 additions & 0 deletions assets/output_contract.tsv
Original file line number Diff line number Diff line change
Expand Up @@ -428,6 +428,7 @@ switch VIRAL_REF - - - - experimental - -
switch MEGANE_KMERS - - - - experimental - -
switch MOCHA_DATA - - - - experimental - -
switch GRIDSS - - - - stable - -
switch TIDDIT - - - - stable - -
switch IMPUTATION - - - - stable - -
switch SOMATIC - - - - stable - -
switch EXTRA_CALLERS - - - - stable - -
Expand All @@ -436,6 +437,7 @@ switch FAMILIES - - - - experimental - -
switch OWNGENOME_LIVE_URL - - - - experimental - -
switch LOCITYPER_DATA - - - - experimental - -
switch LOCITYPER_BG_REGION - - - - experimental - -
switch EVERYTHING - - - - stable - -
switch NXF_VER - - - - stable - -
switch NXF_WORK - - - - stable - -
switch NXF_HOME - - - - stable - -
Expand Down
1 change: 1 addition & 0 deletions assets/steps.tsv
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ step label tool recorded processes sections upstream hours hours_from hours_low
03c Strelka2 yes 02
03d Octopus yes 02 4 estimate
04 Manta manta yes MANTA manta 02 0.68 measured 0.3666
04a TIDDIT yes 02
04b GRIDSS yes 02 8 estimate
05 AnnotSV annotsv yes ANNOTSV annotsv 15,19,18 0.03 measured 0.0166
06 ClinVar screen clinvar yes CLINVAR_SCREEN,CLINVAR_CDNA_CHECK clinvar,carrier 03 0.02 measured 0.0083 clinvar_file_date
Expand Down
Loading
Loading