Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ Each release's notes. From 1.0.0 on, a major or minor release has hand-written n

## Unreleased

- The couple carrier screen (step 39) now says when a change can affect a child, not only make a carrier, and when a call is weak. Before, it told the carrier of a BRCA1, MLH1 or LDLR change that a child "can be a carrier, not affected", gave a MECP2 or PCDH19 change the recessive "daughters are carriers" wording, read a male's call in PAR1 as hemizygous when no PAR file was given, read a haploid autosome call as homozygous, and counted a GQ 1, DP 1 call like any other. Now:
- `assets/carrier_genes.tsv` gets a `dominant` column: `AD` or `SD` on the 43 genes the ACMG secondary findings list gives as dominant, and `XLD` on the 28 X-linked genes that also have an X-linked dominant disorder (GLA, PLP1, FMR1 and GJB1 among them). A one-partner row in an `AD` or `SD` gene reads that a child who inherits the change can be affected, 1 in 2 per child; its `offspring_risk` is `each child 1 in 2, dominant` instead of `none shared`, or `every child, dominant` when that partner carries the change on both copies. Two heterozygous changes in one partner add a note that every child inherits one when they sit on different copies. When a female and a male partner both carry a change in one X-linked recessive gene, `offspring_risk` adds `daughters 1 in 2, can be affected`. An `XLD`-marked gene keeps the X-linked recessive wording and adds that females can show signs.
- The `inheritance` column gets the value `XLD` for 28 X-linked genes whose main disorder is dominant: every X-linked disorder Orphanet gives them is dominant, or they are CDKL5, IKBKG, MECP2 or OFD1. Their rows read that a daughter or a son who inherits the change can be affected. `og couple genes` writes both columns.
- Without `--par-bed`, `og couple screen` uses GRCh38's pseudoautosomal regions, the rows of `assets/par_grch38.bed`. Both callers pass the file, so a pipeline run does not change.
- A haploid call on an autosome or in a pseudoautosomal region (genotype `1`) is one copy: "one copy, a haploid call (1)". Beside a partner's het call it gives 1 in 4, not 1 in 2.
- A ClinVar call below step 06's floor (GQ 30 and DP 10, or the hits file's `##PGP_CALL_FLOOR` line) is marked "low-confidence call (GQ .., DP ..): check the reads". It still counts, and its row says to confirm it before reading the chance; the report's table counts these calls.
- Each ClinVar finding ends with the condition ClinVar names for the allele (`CLNDN`, without "not provided").
No column is renamed or removed. Part of #411.
- Step 39's couple carrier screen now runs in the Rust `og` binary: `og couple screen` in `scripts/39-couple.sh` and the Nextflow `COUPLE_CARRIER` process, and `og couple genes` to rebuild `assets/carrier_genes.tsv`. They replace `bin/couple_report.py`, which is gone, with the two modules only it still used, `bin/cnvpytor_to_vcf.py` and `bin/paraphase_report.py`. Their tests (`tests/test_couple_report.py`, `test_paraphase_report.py` and `test_paralog_loci.py`) are now cargo tests in og-couple and og-steps. The outputs are the same, byte for byte, on the 37 parity cases, except for the two changes below. No option, output file or column changes. On a synthetic couple with 200,000 ClinVar hits and 100,000 Delly deletions each, the screen takes 3.0-3.5 s and 206 MB, where the Python took 25.5-28.8 s and 327-329 MB. Rebuilding the carrier list takes 6.5 s and 40 MB instead of 8.7 s and 320 MB. What changes on purpose:
- The screen reads and computes every couple before it writes a file. The Python wrote each couple's files as it went, so an error on the second couple left the first couple's files new and the second's old or missing. Now an error stops the step with nothing written. Two couples whose file names would be the same (sample ids with `_`, as A with B_C and A_B with C) stop it the same way, where the Python let the second couple overwrite the first's files.
- `og couple genes` refuses an Orphadata file with no root element or one cut off before its root closes. The Python's XML parser refused it too.
- The header lines of `assets/carrier_genes.tsv` name `og couple screen`, `og summary collect` and `og couple genes` where they named the Python files. The gene rows do not change.
- The reports now get summary.json from the Rust `og` binary. Step 24, the Nextflow HTML_REPORT process and `generate-report.sh` collect it with `og summary collect` (through `bin/render_report.py`), and a run collects each sample once: `generate-report.sh` renders the text report from the summary.json step 24 wrote, and collects again when a file it reads is newer than that summary.json, or a file was added to or removed from a step folder since, or a file a section names as its source, the run status or a table in `bin/` or `assets/` is gone. When it renders from step 24's summary.json, the text report's generated time is step 24's, the same as the HTML report's; it was the minute of its own collect. When it collects again, the text report carries the new collect's values and time, and the HTML report keeps step 24's until step 24 runs again, as before. The deliberate fixes the `og summary collect` entries below list now reach the reports; apart from them, nothing in summary.json or either report changes. `bin/collect_summary.py` keeps only what the report renderer (`bin/render_report.py`), the couple report, the results index and the live view import from it. The Python modules that only the old collector imported are gone: `bin/pgx_outside_calls.py`, `ancestry_fine_report.py`, `clip_check.py`, `annotsv_postfilter.py`, `chip_report.py`, `traits_report.py`, `run_delta.py` and `genotype_rules_indels.py`. On the synthetic demo sample (4.7 million VCF records) the collect takes 1.1 s of CPU and 12-15 MB, where the Python took 7.8-8.0 s and 34-37 MB. What changes on purpose:
- The walk of the sample folder leaves out `<sample>/nextflow`. `run-all.sh` launches Nextflow there, and its `work/` holds every task's files and staged links. No section reads a file there. With 200,000 files under it, the collect took 67 MB walked and 14 MB skipped.
- The sections other than the sample VCF are read one at a time, while the sample VCF is read on its own thread, so the peak memory is near the biggest section's and not the sum of all of them. With every side table 50 times its demo size, the peak footprint fell from 119-130 MB to 105-112 MB (the Python: 100-102 MB), with the same CPU time.
Expand Down
Loading
Loading