Multi-sample coverage browser
Project description
covviz
Coverage visualization; a companion viewer for indexcov results.
Here we use indexcov
to quickly estimate the coverage across samples then find regions of large,
coverage-based anomalies. The aim is to highlight regions of significant
(passing the user's z-score threshold) and sustained (beyond user specified
distance) deviation from the majority of samples. Significance is determined
using z-scores (--zthreshold
) for all samples at all points using median
absolute deviation, but in order to be highlighted, points must be significant
consecutively throughout a user specified distance (--distancethreshold
).
Usage
Install nextflow
:
curl -s https://get.nextflow.io | bash
Full nextflow installation instructions are available at: https://www.nextflow.io/
To simplify prerequisite software installations and software version tracking,
we strongly recommend running covviz
using Docker or Singularity. Docker
installation instructions for your operating system are available at:
https://docs.docker.com/install/
Then, with Docker or Singularity we run:
nextflow run brwnj/covviz -latest -profile docker \
--indexes 'data/indexes/*.crai' \
--fai data/g1k_v37_decoy.fa.fai \
--gff data/Homo_sapiens.GRCh37.82.gff3.gz
Which gives us ./results/covviz_report.html
.
Required arguments
--indexes
- quoted file path with wildcard ('*.crai') to cram or bam indexes
--fai
- file path to .fai reference index
--gff
- file path to gff matching genome build of
--indexes
- file path to gff matching genome build of
Options
--outdir
- output directory for results
- default: "./results"
--sexchroms
- sex chromosomes as they are in
--indexes
- default: "X,Y"
- sex chromosomes as they are in
--exclude
- regular expression of chromosomes to skip
- default: "^GL|^hs|^chrEBV$|M$|MT$|^NC|random$|Un|^HLA\-|_alt$|hap\d+$"
--zthreshold
- a sample must greater than this many standard deviations in order to be found significant
- default: 3.5
--distancethreshold
- consecutive significant points must span this distance in order to pass this filter
- default: 150000
--slop
- leading and trailing segments added to significant regions to make them more visible
- default: 500000
--project
- can be used to name your indexcov to something more meaningful
- default: "NF"
Report
Interactive example
See: https://brwnj.github.io/covviz/
Scaled chromosome coverage
Significant regions will be displayed in color atop a gray region which represents the upper and lower bounds of a given point minus any values deemed significant.
Proportions covered
The metadata table will be displayed below the plots.
Interaction
Clicking on plot traces highlights the line and searches the metadata. Double-clicking de-selects lines, resets the plot, and de-selects samples from the table. Clicking on the gene track launches a search for the gene's respective Gene Card. In cases where genes overlap, multiple windows/tabs will be opened.
License
covviz is free and unrestricted for non-commercial use. For commercial use, please contact [bpedersen@base2genomics.com].
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file covviz-1.0.4.tar.gz
.
File metadata
- Download URL: covviz-1.0.4.tar.gz
- Upload date:
- Size: 35.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7bc71a0e264bc4225f9105df54a6e9968f55a6ab20cc7785ea5184a34f6d2967 |
|
MD5 | a1c870ac1b15b25a44786cea5da0ef90 |
|
BLAKE2b-256 | 4eceaeea1910cbac1993e0a8067461dc1669a7abfb827f3ef859bef682a33c60 |
File details
Details for the file covviz-1.0.4-py3-none-any.whl
.
File metadata
- Download URL: covviz-1.0.4-py3-none-any.whl
- Upload date:
- Size: 35.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc4a66e9f31eac042836b98c9fd449dcd02ef573746e166830a1c4dcff8b748e |
|
MD5 | 3e9ad08d4dbc072c1d4960fa1d767fa5 |
|
BLAKE2b-256 | 697535291e6d37ed2140e269728e8bd93bfc84f0a9035ff9ab05a04094bd9e43 |