Back to .md Directory

Tutorial Review Guide

Lists 12 tutorials across three phases with run commands, key files, and review checkpoints for a genomic visualization platform.

May 2, 2026
0 downloads
1 views
ai
View source

What this file does

Lists 12 tutorials across three phases with run commands, key files, and review checkpoints for a genomic visualization platform.

When to use it

  • Onboarding new developers to the tutorial structure
  • Reviewing progress through frontend, backend, and advanced viz phases
  • Checking off understanding of each tutorial's core concepts
  • Planning a quick overview or deep dive session

Assumes this stack

Node.jsnpmD3.jsExpressPostgreSQLR

Tutorial Review Guide

Quick reference for running and understanding each tutorial.


šŸš€ Quick Start Commands

# Navigate to any tutorial and run:
cd tutorials/phase-X-xxx/XX-tutorial-name
npm install
npm run dev
# Open http://localhost:5173 (or shown port)

Phase 1: Frontend Fundamentals

1.1 SVG & Canvas Basics

cd tutorials/phase-1-frontend/01-svg-canvas
npm install && npm run dev

Key Files:

  • src/01-svg-basics.js - SVG elements, shapes, attributes
  • src/02-svg-paths.js - Path commands (M, L, Q, C, A)
  • src/03-canvas-basics.js - Canvas 2D context drawing
  • src/04-interactivity.js - Mouse events, hover, click
  • src/05-comparison.js - SVG vs Canvas trade-offs

What to Look For:

  • How SVG elements are created/styled
  • Path command syntax (d attribute)
  • Canvas immediate-mode vs SVG retained-mode
  • Event handling differences

1.2 D3 Core Concepts

cd tutorials/phase-1-frontend/02-d3-core
npm install && npm run dev

Key Files:

  • src/01-selections.js - select(), selectAll(), append()
  • src/02-data-binding.js - data(), enter(), exit(), join()
  • src/03-scales.js - scaleLinear, scaleOrdinal, scaleBand
  • src/04-transitions.js - transition(), duration(), ease()
  • src/05-genomic-chart.js - Putting it all together

What to Look For:

  • D3 selection chaining pattern
  • Enter-update-exit pattern
  • Scale domain/range mapping
  • Transition interpolation

1.3 Lollipop Plot

cd tutorials/phase-1-frontend/03-lollipop-plot
npm install && npm run dev

Key Files:

  • src/01-basics.js - Basic lollipop structure
  • src/02-domains.js - Protein domain rendering
  • src/03-mutations.js - Mutation markers
  • src/04-interactive.js - Tooltips, zoom, brush
  • src/05-complete.js - Full implementation

What to Look For:

  • Vertical lines + circles pattern
  • Domain rectangles with labels
  • Color coding by mutation type
  • Zoom/pan interactions

1.4 Genome Browser

cd tutorials/phase-1-frontend/04-genome-browser
npm install && npm run dev

Key Files:

  • src/01-coordinate-system.js - Genomic coordinates
  • src/02-tracks.js - Track container pattern
  • src/03-gene-track.js - Gene/exon rendering
  • src/04-navigation.js - Pan, zoom, coordinate input
  • src/05-complete.js - Multi-track browser

What to Look For:

  • Coordinate transformation (bp → pixels)
  • Track stacking layout
  • Gene structure (exons, introns, UTRs)
  • Navigation controls

Phase 2: Backend Development

2.1 REST API

cd tutorials/phase-2-backend/01-rest-api
npm install && npm run dev

Key Files:

  • src/server.js - Express setup, routes
  • src/routes/ - API endpoints
  • src/middleware/ - Error handling, validation

What to Look For:

  • Express route patterns
  • Request/response handling
  • Error middleware
  • API documentation

2.2 PostgreSQL

cd tutorials/phase-2-backend/02-postgresql
# Requires PostgreSQL running
npm install && npm run dev

Key Files:

  • src/db.js - Connection pool setup
  • src/models/ - Data models
  • src/queries/ - SQL queries

What to Look For:

  • Connection pooling
  • Parameterized queries
  • Genomic data schema

2.3 File Parsing

cd tutorials/phase-2-backend/03-file-parsing
npm install && npm run dev

Key Files:

  • src/parsers/vcf.js - VCF file parsing
  • src/parsers/bed.js - BED file parsing
  • src/parsers/maf.js - MAF file parsing

What to Look For:

  • Streaming file reads
  • Format-specific parsing logic
  • Error handling for malformed files

2.4 R Integration

cd tutorials/phase-2-backend/04-r-integration
# Requires R installed
npm install && npm run dev

Key Files:

  • src/r-bridge.js - Node.js ↔ R communication
  • src/analysis/ - R scripts for statistics

What to Look For:

  • Child process spawning
  • Data serialization
  • Statistical computations

Phase 3: Advanced Visualizations

3.1 Scatter Plot

cd tutorials/phase-3-advanced-viz/01-scatter-plot
npm install && npm run dev

Key Files:

  • src/scatter.js or src/main.js - Main implementation
  • Look for: scales, axes, points, brush selection

What to Look For:

  • X/Y scale setup
  • Point rendering with data binding
  • Brush selection for filtering
  • Axis labels and ticks

3.2 Heatmap

cd tutorials/phase-3-advanced-viz/02-heatmap
npm install && npm run dev

Key Files:

  • src/heatmap.js - Matrix rendering
  • Color scales, clustering, dendrograms

What to Look For:

  • Matrix cell rendering
  • Color scale (diverging/sequential)
  • Row/column labels
  • Optional: clustering dendrograms

3.3 Survival Curves

cd tutorials/phase-3-advanced-viz/03-survival-curves
npm install && npm run dev

Key Files:

  • src/survival.js - Kaplan-Meier implementation
  • Step function rendering, confidence intervals

What to Look For:

  • Step function (stairs) rendering
  • Confidence interval bands
  • Censoring marks
  • Log-rank test statistics
  • At-risk table

3.4 Volcano Plot

cd tutorials/phase-3-advanced-viz/04-volcano-plot
npm install && npm run dev

Key Files:

  • src/volcano.js - Differential expression viz
  • Threshold lines, point coloring

What to Look For:

  • Log2 fold change (x) vs -log10 p-value (y)
  • Significance threshold lines
  • Color coding (up/down/not significant)
  • Gene labels for top hits

3.5 OncoPrint

cd tutorials/phase-3-advanced-viz/05-oncoprint
npm install && npm run dev

Key Files:

  • src/oncoprint.js - Mutation matrix
  • Gene Ɨ Sample grid with mutation glyphs

What to Look For:

  • Gene rows Ɨ Sample columns
  • Mutation type glyphs (colors/shapes)
  • Sorting by mutation frequency
  • Track annotations

šŸ“‹ Review Checklist Template

For each tutorial, check:

ā–” Code compiles without errors
ā–” Visualization renders in browser
ā–” Understand data flow (data → scales → elements)
ā–” Identify D3 patterns used
ā–” Note any genomics-specific logic
ā–” Test interactivity (if any)

šŸŽÆ Recommended Review Order

Quick Overview (1-2 hours):

  1. 01-svg-canvas → See SVG/Canvas basics
  2. 02-d3-core → Understand D3 patterns
  3. 03-lollipop-plot → Core ProteinPaint viz
  4. 02-heatmap → Matrix visualization
  5. 03-survival-curves → Statistical viz

Deep Dive (add more time per tutorial):

  • Focus on the src/ files
  • Read the README.md for each
  • Modify parameters and see effects
  • Add console.log to trace data flow

šŸ’” Tips for Efficient Review

  1. Use Browser DevTools: Inspect SVG elements, see computed styles
  2. Add Console Logs: Trace data transformations
  3. Modify Constants: Change colors, sizes, see immediate effects
  4. Check Network Tab: See data loading (if external)
  5. Use VS Code Split View: Code on left, browser on right

What's inside

3 phase sections, 12 tutorial entries, 1 review checklist template, 1 recommended order list, 1 tips list

Change this for your project

  • Replace sdodlapati3/genomic-viz-platform with your own repository name
  • Replace tutorials/phase-X-xxx/XX-tutorial-name paths with your actual tutorial directory structure

Where it goes

Keep it in your repository where the agent or team that needs it will read it.

Worth borrowing

  • Grouping tutorials into phases with consistent run commands and key files for each
  • Providing a review checklist template that can be copied per tutorial
  • Offering a recommended review order for time-constrained readers

Related Documents