• Stars
    star
    107
  • Rank 323,587 (Top 7 %)
  • Language
    Nim
  • License
    MIT License
  • Created almost 5 years ago
  • Updated almost 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

igv.js standalone page generator and automatic configuration to view bam/cram/vcf/bed. "working in under 1 minute"

igv.js is a great way to view aligments and other genomic data. It requires that the files are hosted on a server with access to the original data. javascript.

jigv encodes all variants, alignments, and annotations into a single HTML page (or as separate javascript file for each variant) that you can send to collaborators who don't have access to the cluster where your data is stored.

The resulting file is very fast to navigate; the left/right arrow keys advance to next/previous variants of interest.

Usage looks like:

jigv \
    --sample HG01053 \     # the sample of interest drawn in top panel
    --ped trio.ped \       # jigv will use this to also show parents and sibs of --sample
    --sites dn.vcf.gz \    # e.g. candidate de novo varants
    --fasta $reference_fasta \
    --annotation hg38.refGene.bed.gz \ # see: https://github.com/brentp/jigv/wiki/bed12
    --annotation LCR-hs38.bed.gz \     # specify as many of these as needed.
    /path/to/*.cram > denovos.html

With that, denovos.html will contain all genomic data around variants of interest embedded within it.

With this, we are able to encode 924 candidate de novo variants into a 31MB html file that includes alignments for the proband, mom, and dad.

See Examples for more

installation

grab a static linux binary from releases

notes and features

navigation

jigv supports navigation along variants in a VCF file using the left and right arrow keys. it uses the --sites VCF track as the one to navigate through.

automated screenshots

given an html file at e.g. denovos.html, a PNG screenshot for region=chr5:1410040-1412784 can be created with

google-chrome --window-size=1200,1200  --virtual-time-budget=10000 \
   --headless --run-all-compositor-stages-before-draw \
   --screenshot=${region/:/-}.png "denovos.html#$region"

This can be scripted with your favorite language for a set of regions.

options

  jigv [options] [xams ...]

Arguments:
  [xams ...]       indexed bam or cram files for relevant samples. read-groups must match samples in vcf.

Options:
  --sample=SAMPLE            sample-id for proband or sample of interest (default is first vcf sample)
  --sites=SITES              VCF or BED containing variants of interest for --sample. If this contains ':', then it's used as a single region and the first bam/cram given is the sample of interest. If it ends with '.bed' or '.bed.gz' it's assumed to be BED format.
  -g, --genome-build=GENOME_BUILD
                             genome build (e.g. hg19, mm10, dm6, etc, from https://s3.amazonaws.com/igv.org.genomes/genomes.json).  If this is specified then the page will request fasta, ideogram and gene data from a server.
  --cytoband=CYTOBAND        optional path to cytoband/ideogram file
  --annotation=ANNOTATION    path to additional bed or vcf file to be added as a track; may be specified multiple times
  --ped=PED                  pedigree file used to find relations for --sample
  --prefix=PREFIX            if specified, encoded data for each region is written to it's own js file and no html is generated. this is a path prefix like: 'jigv_encoded/HG002/' where  where and `$site.js` will be added by jigv
  --prefix-raw               by default if --prefix is specified, the data is written to a javascript variable and includes the 'data:base64' prefix. if this option is also specified, then the raw base64 encoded data is written to the file.
  --fasta=FASTA              path to indexed fasta file; required for cram files
  --flank=FLANK              bases on either side of the variant or region to show (default: 100) (default: 100)

prefix

By default, jigv will embed all data for all sites into a single html file. This can scale up to about 2000 variants for a trio at which point the single file becomes quite large (~60MB). Using --prefix, it's possible to send each encoded site to a separate file. These can be loaded on demand from a server or sent to the user and loaded as a script on demand from the local file system.

Files written with --prefix but without --prefix-raw' can be loaded from the local file-sytem of the user (or from a server depending on if they are viewing as file:///...` on their local system or on a server. The code for that looks like this:

    var jigv_data; // define this here, but it is set when the script is loaded.
    var s = document.createElement("script")
    s.type = "text/javascript"
    s.src = "$sample/chr1-1746431-A-T.jigv.js" // path to whichever file made by jigv.
    s.onload = function(a, b) {
        jigv_data["showChromosomeWidget"] = false
        jigv_data["search"] = false
        jigv_data["queryParametersSupported"] = true
        jigv_data["showCursorTrackingGuide"] = true

        var div = document.getElementById("igv")
        meta_options = {"sessionURL": jigv_data }
        igv.createBrowser(div, meta_options)
    }

note that jigv writes the data as jigv_data so once the file is loaded, it can be accessed via that variable name.

limitations

  • if you have some custom javascript used with igv.js, that is generally useful, please open an issue so I can add it.
  • not all file types are supported
  • the sites file must contain only the variants to plot; there is no filtering in jigv

See Also

  • igv-reports by the IGV team does this as well. jigv adds extra features for working with pedigrees, reducing dependencies, and reducing the output size. That said, igv-reports may work well for your use-case.

examples

  1. a set of bam files given a set of regions in BED format:
jigv \
    --fasta $fasta \
    --sites $bed \
    /path/to/*.bam > regions.html

This will use the first 8 bam files. Beyond that number the files are too large.

  1. a set of de novo variants for a trio:
jigv \
    --sample $proband \     # the sample of interest drawn in top panel
    --ped trio.ped \        # jigv will use this to also show parents and sibs of --sample
    --sites dn.vcf.gz \     # file with candidate de novo varants
    --fasta $fasta \
    --annotation hg38.refGene.bed.gz \ # see: https://github.com/brentp/jigv/wiki/bed12
    --annotation LCR-hs38.bed.gz     \ # specify as many of these as needed.
    /path/to/*.cram > denovos.html
  1. a single region
jigv \
    --sample $proband \     # the sample of interest drawn in top panel
    --ped trio.ped \        # jigv will use this to also show parents and sibs of --sample
    --sites "chr1:3453454-3453554" \  # single region.
    --fasta $fasta \
    --annotation hg38.refGene.bed.gz \ # see: https://github.com/brentp/jigv/wiki/bed12
    --annotation LCR-hs38.bed.gz     \ # specify as many of these as needed.
    /path/to/*.cram > denovos.html

More Repositories

1

cyvcf2

cython + htslib == fast VCF and BCF processing
Cython
366
star
2

vcfanno

annotate a VCF with other VCFs/BEDs/tabixed files
Go
332
star
3

goleft

goleft is a collection of bioinformatics tools distributed under MIT license in a single static binary
Go
202
star
4

slivar

genetic variant expressions, annotation, and filtering for great good.
Nim
189
star
5

smoove

structural variant calling and genotyping with existing tools, but, smoothly.
Go
187
star
6

bio-playground

miscellaneous scripts for bioinformatics/genomics that dont merit their own repo.
C
181
star
7

somalier

fast sample-swap and relatedness checks on BAMs/CRAMs/VCFs/GVCFs... "like damn that is one smart wine guy"
Nim
180
star
8

hts-nim

nim wrapper for htslib for parsing genomics data files
Nim
149
star
9

cruzdb

python access to UCSC genomes database
Python
129
star
10

peddy

genotype :: ped correspondence check, ancestry check, sex check. directly, quickly on VCF
Jupyter Notebook
122
star
11

bwa-meth

fast and accurate alignment of BS-Seq reads using bwa-mem and a 3-letter genome
Python
116
star
12

echtvar

using all the bits for echt rapid variant annotation and filtering
Rust
105
star
13

combat.py

python / numpy / pandas / patsy version of ComBat for removing batch effects.
Python
98
star
14

intintmap

fast int64-int64 map for go
Go
93
star
15

duphold

don't get DUP'ed or DEL'ed by your putative SVs.
Nim
90
star
16

slurmpy

submit jobs to slurm with quick-and-dirty python
Python
88
star
17

pyfasta

fast, memory-efficient, pythonic (and command-line) access to fasta sequence files
Python
86
star
18

vcfgo

a golang library to read, write and manipulate files in the variant call format.
Go
65
star
19

fishers_exact_test

Fishers Exact Test for Python (Cython)
Python
63
star
20

xopen

open files for buffered reading and writing in #golang
Go
60
star
21

interlap

fast, pure-python interval overlap testing
Python
50
star
22

seqcover

seqcover allows users to view coverage for hundreds of genes and dozens of samples
Nim
49
star
23

rare-disease-wf

(WIP) best-practices workflow for rare disease
Nextflow
49
star
24

hts-python

pythonic wrapper for libhts (moved to: https://github.com/quinlan-lab/hts-python)
Python
49
star
25

go-chartjs

golang library to make https://chartjs.org/ plots (this is vanilla #golang, not gopherjs)
Go
47
star
26

hts-nim-tools

useful command-line tools written to showcase hts-nim
Nim
46
star
27

irelate

Streaming relation (overlap, distance, KNN) of (any number of) sorted genomic interval sets. #golang
Go
45
star
28

bsub

python wrapper to submit jobs to bsub (and later qsub)
Python
43
star
29

combined-pvalues

combining p-values using modified stouffer-liptak for spatially correlated results (probes)
Python
40
star
30

align

sequence alignment. global, local, glocal.
Python
40
star
31

bigly

a pileup library that embraces the huge
Go
39
star
32

indelope

find large indels (in the blind spot between GATK/freebayes and SV callers)
Nim
39
star
33

tiwih

simple bioinformatics command-line (t)ools (i) (w)ished (i) (h)ad.
Nim
39
star
34

cigar

simple library for dealing with SAM cigar strings
Python
37
star
35

gsort

sort genomic data
Go
35
star
36

450k-analysis-guide

A Practical (And Opinionated) Guide To Analyzing 450K Data
TeX
34
star
37

geneimpacts

prioritize effects of variant annotations from VEP, SnpEff, et al.
Python
31
star
38

quicksect

a cythonized, extended version of the interval search tree in bx
Python
30
star
39

poverlap

significance testing over interval overlaps
Python
29
star
40

fastbit-python

pythonic access to fastbit
Python
26
star
41

nim-lapper

fast easy interval overlapping for nim-lang
Nim
24
star
42

lua-stringy

fast lua string operations
C
21
star
43

pybloomfaster

fast bloomfilter
C
21
star
44

vcfassoc

perform genotype-phenotype-association tests on a VCF with logistic regression.
Python
20
star
45

toolshed

python stuff I use
Python
19
star
46

bw-python

python wrapper to dpryan79's bigwig library using cffi
C
19
star
47

methylcode

Alignment and Tabulation of BiSulfite Treated Reads
C
16
star
48

tnsv

add true-negative SVs from a population callset to a truth-set.
Nim
15
star
49

hileup

horizontal pileup
C
15
star
50

nim-kmer

DNA kmer operations for nim
Nim
15
star
51

genoiser

use the noise
Nim
15
star
52

bigwig-nim

command-line querying+conversion of bigwigs and a nim wrapper for dpryan's libbigwig
Nim
15
star
53

vcf-bench

evaluating vcf parsing libraries
Zig
14
star
54

agoodle

numpy + GDAL == agoodle
Python
13
star
55

hts-zig

ziglang + htslib
Zig
12
star
56

aclust

streaming, flexible agglomerative clustering
Python
12
star
57

gobio

miscellaneous script-like stuff in go for bioinformatics
Go
12
star
58

excord

extract SV signal from a BAM
Go
11
star
59

fastahack-python

cython wrapper to fastahack
C++
11
star
60

spacepile

convert reads from repeated measures of same piece of DNA into spaced matricies for deep learners.
Rust
10
star
61

bwa-mips

Map sequence from Molecular Inversion Probes with BWA, strip arms, de-dup, ..., profit
Python
10
star
62

gobe

a fast, interactive, light-weight, customizable, web-based comparative genomics viewer with simple text input format.
Haxe
10
star
63

bix

tabix file access with golang using biogo machinery
Go
9
star
64

sveval

run multiple sv evalution tools
Python
8
star
65

clinical-components

Summarize the clinical (or lab) components and correlations of your dataset.
Python
8
star
66

bowfast

run bowtie then bfast on colorspace reads.
Shell
7
star
67

bcf

bcf parsing in golang
Go
7
star
68

inheritance

inheritance models for mendelian diseases
Python
7
star
69

skidmarks

find runs (non-randomness) in sequences
Python
7
star
70

falas

Fragment-Aware Local Assembly for Short-reads
Nim
7
star
71

bamject

DO NOT USE inject variants (snps/indels) from a vcf into a bam efficiently.
Nim
7
star
72

bpbio

basepair bio: a single binary with many useful genomics subtools.
Nim
6
star
73

kexpr-nim

nim wrapper for Heng Li's kexpr math expression evaluator library
C
5
star
74

clustermodel

fitting models to clustered correlated data
Python
5
star
75

go-blosc

go wrapper for blosc (blocked number compression with fast random access)
Go
5
star
76

celltypes450

adjust for cell-type composition in 450K data using houseman's and other methods.
R
5
star
77

crystal

find clusters and model correlated data from DNA methylation and other genomic sources.
Python
5
star
78

variantkey-nim

nim-wrapper for variantkey -- (chrom, pos, ref, alt) -> uint64
C
4
star
79

pedfile

pedigree file parsing and relatedness calculations for nim
Nim
4
star
80

shuffler

shuffle genome regions to determine probability of user-defined metric
Python
4
star
81

go-giggle

golang wrapper to giggle
Go
4
star
82

bedder-rs

an API for intersections of genomic data
Rust
4
star
83

nim-gzfile

simple reader and writer for gzipped (and regular) files
Nim
4
star
84

find_cns

find conserved non-coding sequences (CNS)
Python
4
star
85

nim-cgranges

nim wrapper for https://github.com/lh3/cgranges for faster interval tree
C
3
star
86

d4-nim

nim-lang wrapper for https://github.com/38/d4-format
Nim
3
star
87

flatfeature

python module for dealing with BED format for genomic data as a numpy array.
Python
3
star
88

faidx

faidx for golang
Go
3
star
89

tabix-py

interface to tabix using cffi
C
3
star
90

4bit

4bit fasta format.
C
3
star
91

ksw2-nim

nim wrapper for lhs/ksw2 for fast smith-waterman
C
3
star
92

htsuse

some C stuff that uses htslib
C
2
star
93

nim-minizip

nothing to see here.
C
2
star
94

pyfastx

unified access to fasta, fastx using kseq.h + ??
C
2
star
95

learnflash

all the stuff i want to remember how to do in haxe / flash
2
star
96

ififo

ififo provides a fast, sized, generic thread-safe FIFO in golang.
Go
2
star
97

dotfiles

my .bash, .vim, .* files
Shell
2
star
98

cysolar

copy of pysolar using cython
Python
2
star
99

cgotbx

yeah, another tabix wrapper for go.
Go
1
star
100

totable

simple python / cython wrapper to tokyo cabinet tables
C
1
star