Docs: new Confidence Tiers page with the tier ladder as a diagram
chimera_evidence.tsv.gz gives every gene-TE pair a confidence_tier, and
until now that number was explained only as a table buried in Interpreting
Your Results. It gets its own page, built around an ASCII ladder that shows
the tiers stacked weakest-to-strongest with the reasoning for each rung
beside it.
Also diagrams what is NOT on the ladder, which is the part people will
otherwise re-derive wrongly: read depth, and telocal_active. Keeps the
measured numbers (91% coverage; 6.7% vs 10.2% canonical rate) next to the
conclusion, because the original reasoning for including TE expression was
plausible enough that someone will reach for it again.
Adds a table of artifact mode vs. what catches it, which is the actual
argument for canonical outranking reproducibility: template switching is
sequence-driven and recurs in every library, so replication does not rule
it out while a splice motif does.
Ends with worked examples of reading a row and awk recipes for cutting the
table down, with the honest framing that the strict set is small and the
remaining tens of thousands of rows are a screen, not a result.
Interpreting Your Results keeps the summary table and now links here instead
of restating the excluded-signals argument, so the two cannot drift.
Cross-linked from Home and Chimera Detection.
Docs: Interpreting Your Results; unified evidence table; BED tracks
New page: Interpreting Your Results. A finished run produces several
sections that all mention TEs, and nothing said which of them are
independent. The page separates the two questions the pipeline answers,
shows in a diagram that TEcount/TElocal are one measurement at two
resolutions while only the two chimera screens are independent, gives the
2-6 confidence ladder, and lists the misreadings that ladder is meant to
prevent.
It also carries the corrected canonical-rate guidance. Comparing gene_to_te
against `other` reads as 2.5x enriched, but the donor's annotation status
alone moves the rate from ~3% to ~10%, so most of that ratio is the donor
side. Against a matched background (gene_to_gene) it is 1.19x. The real
evidence is the pattern, not the ratio: both true gene-TE directions beat
their own donor group while the two classes with a TE but no gene partner
fall below theirs. Table of measured values included.
Chimera Detection: documents chimera_evidence.tsv.gz -- one row per
(gene_id, te_id) pair joining both screens, since junction rows are
breakpoint-keyed and assembly rows transcript-keyed and neither reads as
"the candidate list".
Output Layout: adds the reference/ BED tracks (genes.bed, exons.bed,
te.bed), which were never documented -- only annotation.bed12 was listed.
Notes te.bed's BED9 extension and the name/subfamily split: column 4 is the
individual insertion and joins TElocal, column 9 is the subfamily and joins
TEcount. Also adds the new chimera_evidence, junction_highlights and
evidence_overview outputs.
Add Full Pipeline Flowchart page
The README now has a small, simplified diagram instead; this page is the
full, rule-level one that used to live there (mirrors docs/pipeline-flowchart.md
in the main repo -- refresh by hand if it drifts, same as the rest of this wiki).
Add full documentation: config reference, CLI, HPC/SLURM, TElocal, chimera detection, output layout
Moved out of the main repo's README, which was trimmed to a short landing
page (install + quick start + links here).