Skip to content

Update and expand tutorials against real ENCODE data - #51

Merged
YalanBi merged 17 commits into
masterfrom
docs/tutorial-update
Aug 7, 2026
Merged

Update and expand tutorials against real ENCODE data#51
YalanBi merged 17 commits into
masterfrom
docs/tutorial-update

Conversation

@YalanBi

@YalanBi YalanBi commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator

Summary

Test plan

  • Full test suite passes (25/25) in a fresh clone
  • All notebooks re-executed for real, zero errors
  • Docs build cleanly with Sphinx in a fresh clone
  • black --check and flake8 clean
  • CI green across the full matrix

YalanBi and others added 17 commits August 5, 2026 23:06
The zYe7g6qnyxGDxRd Nextcloud share is no longer live; Mf2zMePGBzFWFk8
is the current working link for the same TutorialsData.zip archive.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The transcript-context filter variable is trid, not transcript_id.
Using transcript_id silently defaults to None, and gene.coverage[:,None]
triggers numpy newaxis broadcasting that crashes any()/all() calls on
the resulting 2D array -- exactly the ValueError reported in #19.
Also corrects 06_filtering.ipynb's cached output, stale since trid was
renamed from transcript_id in the library.
The code cell already calls transcript_table(cpm=True); only the
cached DataFrame output still showed sum_tpm from before the 2.1.0
tpm->cpm rename. Values are unchanged (cpm was always the correct
formula), so only the label needed correcting.
…orial

The .tbi index was required for the reference annotation; that requirement was removed for #28 back in 2.0.3 (plain sequential gzip reading, no TabixFile). Also documents infer_genes=True for gtf/gff3 files without explicit gene entries, which may happen when importing files from external tools.
…rials

Adds consistent logging setup (matching 03/03b's existing pattern) to
04/05/06/08/09/10, which previously had none -- their warnings were
falling through Python's bare last-resort handler with no level
prefix. All 8 notebooks now filter the repetitive "gene name/id ...
is ambiguous" warnings from make_index(), and progress_bar=False is
set on from_reference/add_sample_from_bam/add_qc_metrics/
add_orf_prediction in 03/03b to avoid multi-line tqdm spam in cached
output. 02_api_vs_cli.ipynb's CLI calls filter the same warnings via
grep -v.
New notebook 07_gene_model_characteristics.ipynb covers gene/transcript
access, str_var_calculation/triangle_plot, entropy_calculation, and
gene_track(colorbySqanti=True) -- previously uncovered by any tutorial.
Add importing SQANTI classification file function into 05_qc.ipynb.
@YalanBi YalanBi added the enhancement New feature or request label Aug 6, 2026
@YalanBi YalanBi self-assigned this Aug 6, 2026
@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@YalanBi YalanBi closed this Aug 7, 2026
@YalanBi YalanBi reopened this Aug 7, 2026
@YalanBi
YalanBi merged commit e4e91c0 into master Aug 7, 2026
21 of 39 checks passed
@YalanBi
YalanBi deleted the docs/tutorial-update branch August 7, 2026 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

1 participant