Docs: gene symbols via the gene_id -> gene_name lookup
Output Layout gains a "Gene symbols" section. Every table the pipeline
writes is gene_id-keyed, so with an Ensembl/GENCODE annotation none of them
carry a readable symbol -- results/reference/gene_id_to_name.tsv.gz is how
one gets onto any of them, with a worked R join.
Records the two things that are easy to get wrong when using it: gene_name
is never blank (it falls back to gene_id, so a join cannot silently drop or
unlabel rows), and it is a sidecar rather than a counts-matrix column
because those matrices are loaded with row.names = 1 + as.matrix and hold no
gene rows at all on the default feature_class.
Docs: the strandedness check
Strandedness-and-STAR-2-pass gains a section on the new check. RSeQC now
runs on every sample by default (strandedness.check_provided), and the
report compares what samples.csv declared against what the reads look like,
flagging mismatches.
States plainly that a mismatch is reported, never applied -- an explicit
sample sheet value still wins for quantification -- since a check that
silently corrected the sheet would be worse than no check.
Also covers how to read one: the Failed fraction first, and the difference
between "genuinely unstranded" and "RSeQC could not tell", which produce the
same call for different reasons.
Corrects step 2 of the resolution list, which said only auto samples "go
through RSeQC" -- they are now only the ones that TAKE their value from it.
Output Layout: adds strandedness_check_mqc.json.
Interpreting Your Results: reading order points at the check first.
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.
Docs: chimera.assembly is now enabled by default
It costs a second dedicated STAR pass per sample, and is still newer and
less validated than the junction screen, so the docs say both.
Chimera docs: which file is which, ambiguous classification, gene-TE naming
- Chimera-Detection: table showing the four per-sample files are two
row-sets x two column-sets; the new direction_ambiguous flag and when
to distrust `direction`; other_to_te; and a note that the non-gene-TE
buckets collect circRNA back-splices and read-through/PCR artifacts,
since STAR's chimeric call is structural and annotation-blind.
- Output-Layout: the chimera block was stale (wrong directory name,
missing .gz, missing pca_ prefix, telocal file absent). Rewritten
against the actual rule outputs, plus the chimera_assembly tree
including its dedicated second STAR pass.
- Tool-Versions: add TElocal and StringTie, which were missing.
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).