Skip to content

Demo Data

The repository ships a lightweight demo dataset under demo_data/.

This dataset is intended for:

  • quick user onboarding
  • smoke tests for the main CLI
  • developer regression checks
  • screenshots and examples in the documentation

Included Assets

CSV mode inputs

  • demo_data/example_base.csv
  • demo_data/example_read.csv
  • demo_data/example_reference.csv

BAM mode inputs

  • demo_data/example_chr1_91150_91252.bam
  • demo_data/example_chr1_91150_91252.bam.bai
  • demo_data/example_chr1_1_91252.fa
  • demo_data/example_chr1_1_91252.fa.fai

Reference outputs

  • demo_data/example_base_plot.png
  • demo_data/example_bam_plot.pdf

CSV Mode Demo

plot2insights \
  --layout base \
  --base-df demo_data/example_base.csv \
  --read-df demo_data/example_read.csv \
  --reference-df demo_data/example_reference.csv \
  --output /tmp/insight-demo-base.png

Expected result:

Demo base plot

BAM Mode Demo

plot2insights \
  --layout base \
  --bam demo_data/example_chr1_91150_91252.bam \
  --reference-fasta demo_data/example_chr1_1_91252.fa \
  --region 1:91150-91252 \
  --output /tmp/insight-demo-bam.pdf

This BAM example uses the same region and is intentionally small enough for repeatable testing.

Why This Matters

Without a stable demo dataset:

  • users must prepare their own BAM or CSV inputs before they can try the tool
  • documentation examples become harder to trust
  • developers lose a simple smoke-test fixture

demo_data/ solves those problems by providing a reproducible, repository-local sample.