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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Each release's notes. From 1.0.0 on, a major or minor release has hand-written n
- Step 46's LPA KIV-2 message now says what its interval covers and what the count adds up. It read `about N KIV-2 repeats in total (95% interval LOW to HIGH)`, which looked like a calibrated range for one chromosome. The interval comes only from how the depth varies between exons, read as independent, so it covers read sampling and leaves out any aligner or library bias; the count is the total over both copies of chromosome 6. The message is now `about N KIV-2 repeats in total over both copies (95% interval for read sampling, LOW to HIGH; aligner or library bias not included)`, then the class reading as before. Only the `message` value of `lpa/<sample>_lpa_kiv2.tsv` and the step's stdout line change; the columns `kiv2_copies`, `ci95_low` and `ci95_high` keep their names and values.
- Each `run-all.sh` run now ends with `bin/og facts`, which writes `facts/<sample>_genome_facts.json` in the format `ownhealth.genome-facts/v1`, readable by its owner only (mode 600). [OwnHealth](https://github.com/GeiserX/OwnHealth) imports this file, with the sample's VCF, to show the genome next to the rest of a person's record: `docs/ownhealth.md` says how. The file is a stable output under the 1.0 promise and is listed in the output contract. It is skipped when the HTML report fails, and an earlier run's file is removed before a run starts. A plain `nextflow run main.nf` does not write it yet; `bin/og facts` writes it by hand.
- `og report index build --summary summary.json [--sample-dir DIR] -o <sample>_search_index.json` writes the run's search index in Rust. `og report index query --index FILE QUERY` answers one query with the rule of the live site's search box (`assets/live/plugins/search.js`); a cargo test runs that script under node against the Rust rule. The file is the one `bin/results_index.py` writes: the same terms, sections, anchors, counts and mentions, and the same answer to each query. No step calls the verb yet: step 24 and the Nextflow report still write the index with `bin/results_index.py`. One field is not written yet: `veil`, which tags an item that names a result a child's page keeps closed. It needs the live site's findings, which are not ported yet.
- `og report charts --summary summary.json --charts-json <sample>_charts.json` builds the report's five charts in Rust: the ClinVar stars, the genome (runs of homozygosity, ClinVar hits, AnnotSV class 4 and 5 SVs, MoChA calls), the heteroplasmic chrM sites, fine-grained ancestry and the PRS percentiles, each as data and as inline SVG. It writes the same file as `bin/render_report.py --charts-json`, byte for byte, on the 154 summaries of the report corpus, and prints the same "Sections:" line. The specs are built once in `og-render` (`charts::build`), with each chart's HTML report line (`charts::figure`) for the report and the JSON for the live page. No step calls it yet: `bin/render_report.py` still writes the charts until the reports switch to og. The chart checks of `tests/test_report_charts.py` moved to `rust/crates/og-render/tests/charts.rs`. The file keeps the checks of what `bin/render_report.py` still ships: where each chart sits in the HTML report, two renders giving the same charts file, and the live page in a browser.
- Step 37 and the Nextflow `Y_HAPLOGROUP` process run Yleaf through its own command line. `bin/yleaf_run.py`, our Python launcher that patched Yleaf at run time (its data folder, its reference, its samtools calls and its process pools), is gone. Yleaf 4.1.7 has the options the launcher stood in for: `-rp` reads the pileup the step makes beside the chrY BAM, `--ref-fasta` names the reference so it downloads none, and `--no-update-check` keeps it offline. Yleaf now predicts with the marker table and tree its image ships; the image test checks they are the files of the archive `setup.sh --yleaf-data` installs, whose positions the pileup is made at, and that Yleaf still has those options, that pileup file and the samtools flags the pileup uses. When no read falls on any marker, Yleaf stops before it predicts, so `og y yleaf-no-reads` writes the row it gives for too few markers (`Hg` NA, the BAM's mapped reads), as the launcher did. On the fixture's chrY slice the prediction table and every file Yleaf writes are the same, byte for byte, as with the launcher, and so is the empty-pileup row. No option, output file or column changes. Step 37 now stops with a clear message when `REF_FASTA` does not end in `.fa`, `.fasta` or `.fna` (a compressed FASTA, say): Yleaf's `--ref-fasta` takes no other name, and the Nextflow `--reference` already asks for a plain FASTA. `setup.sh` installs `.fasta`.
- The exome guide no longer says the drug-gene steps work unchanged on an exome. Some variants that define a star allele sit outside the coding exons, such as CYP2C19 \*17, CYP3A5 \*3, CYP3A4 \*22 and UGT1A1 \*28 and \*80, so a typical capture does not read them. PharmCAT then cannot call those alleles, and a gene can read as normal function when it is not. `docs/wes-guide.md` now lists the PharmCAT 3.4.0 positions that a capture of the coding exons misses, gene by gene, and tells you to check `${SAMPLE}.missing_pgx_var.vcf` before you act on a call from an exome. Step 7's limitations say the same. Docs only; no output changes.
- Four commands in docs tables now copy and run as written. The docs site printed the backslash that escaped each pipe for GitHub, so the Nextflow install line in Getting started read `curl -s https://get.nextflow.io \| ...`, which is not a pipeline. That row now points at the install command in Full run. The BAM build check of the FAQ and the site table hash of Keeping versions up to date moved into code blocks under their tables, and the `readings` row of Copy Number from Depth names its separator in words. `tests/test_docs_table_pipes.sh` fails when a table row under `docs/` holds an escaped pipe inside a code span.
Expand Down
Loading
Loading