dummy-link

VariantVisualization

Julia package powering VIVA, our tool for visualization of genomic variation data. Manual:

Readme

VIVA: A VCF File Visualization Tool and VariantVisualization.jl

Visualization of Genomic Variants from VCF Files

MacOS / Linux Windows License Test Coverage Documentation Lifecycle
Travis Build status License Coverage Status Docs Docs Lifecycle

Overview

VariantVisualization.jl is a package we built specifically to power the genetics visualization tool, VIVA.

VIVA is a user-friendly command line tool for creating publication quality graphics from Variant Call Format (VCF) files. It has been designed for clinicians and bioinformaticians to explore their VCF files visually. In a single command, users can extract genotype or read depth information and plot trends in interactive categorical heatmaps and scatter plots of average read depth values. VIVA offers a robust set of filters to select variants and samples of interest for analysis. VIVA is especially useful in early data exploration for identifying batch effect and sources of poor read depth in sequencing experiments, as well as identifying distribution of disease causing variants in a set of clinical samples.

Getting Started:

Installation

Supported Operating Systems:

macOS ( Sierra, High Sierra, and Mojave ), Windows (7 and 10), and Linux.

Step 1: Install Julia

  1. Download Julia and install the language following the platform specific instructions.

  2. Then, follow add Julia to the path variable to run VIVA.

To add Julia to the PATH on Windows 7 or Windows 10:

Add the path to the Julia binaries (C:\Program Files\Julia\bin) to the PATH following the concise instructions found here

To add Julia to the PATH on Mac run the following line in the Terminal:

sudo ln -s /Applications/Julia-1.2.app/Contents/Resources/julia/bin/julia /usr/local/bin/julia

Be sure to replace "/Applications/Julia-1.2.app/..." to reflect the version of Julia you've downloaded.

Linux Note: To run on remote compute clusters, you may need to load the opengl and julia modules.

Step 2: Install VariantVisualization.jl

To run the VIVA command line tool and VIVA Jupyter Notebook, you'll need to install our VariantVisualization.jl Julia package which powers VIVA.

To install VariantVisualization.jl:

  1. Open the command line or PowerShell
  2. Run the following block of code julia ]add VariantVisualization exit() ### Step 3: Run viva

Mac and Linux

On Mac and Linux, open another terminal window, navigate to your project folder and run:

viva -f filename.vcf -s  -o output/directory/

Windows

!!! Warning Viva will not work with Win32.

On windows, after installing VariantVisualization, open a new PowerShell and run:

viva -f filename.vcf -s  -o output/directory/

You'll then be prompted to select an application to open the script. Select the Julia executable, that is normally located at C:\Usersjulia-observer-quote-cut-paste-1__worklt;username>\AppData\Local\Julia-<version>\bin\.

Optional Step: Install VIVA Jupyter Notebook

To install the VIVA Jupyer Notebook:

  1. Install Jupyter
  2. Download the VIVA Jupyter Notebook.

Then, follow the in-notebook instructions to generate your plots.

Latest Features

To stay up to date with cutting edge development features install VariantVisualization.jl from the Master branch.

From the Julia REPL:

julia
]add VariantVisualization#master

For Developers

Install VariantVisualization in development mode:

julia
]dev VariantVisualization

VIVA Jupyter notebook and the VIVA the command line tool are built with functions contained in our VariantVisualization.jl package.

Developers may contribute to these open source tools by using functions contained within VariantVisualization.jl which are carefully documented with docstrings.

We have included in-line comments within the code for the VIVA command line tool.

The VIVA Jupyter notebook is powered by a main function which takes arguments defined by the user in the notebook. We welcome users to post in issues to request a new feature or bug fix.

Contributing and Questions

Contributions are welcome, as are feature requests and suggestions. Please open an issue if you encounter any problems or would just like to ask a question.

First Commit

03/28/2018

Last Touched

2 days ago

Commits

254 commits

Used By: