Skip to main content

Interactive HTML5 visualization for CRISPR/Cas9 knockout screen experiments.

Project description

[![PyPI](]() [![PyPI](]( [![Conda](](

VISPR - A visualization framework for CRISPR data.

VISPR is a web-based, interactive visualization framework for CRISPR/Cas9 knockout screen experiments.


The easiest way to install VISPR is to use the Miniconda Python distribution ( We recommend to use the Python 3.4 variant. With miniconda installed, you can issue

conda install -c liulab vispr

in a terminal to install or update VISPR with all dependencies. If you are using an old version of MacOS X and the conda command is not available after installation of Miniconda, you have to change your shell to bash. To do this permanently, issue

chsh -s /bin/bash


All steps below have to be executed in a terminal.

### Step 1: Testing VISPR

After successful installation, you can test VISPR with example data by executing

vispr test

in a terminal. This will download test data and allow you to explore all features of VISPR.

### Step 2: Configuring VISPR

VISPR takes [MAGeCK]( and [FastQC]( results as input. To display such results in VISPR, you have to provide a config file that points to result files and sets additional parameters. One config file defines one set of results (i.e. one experiment). The easiest way to generate your own data and create vispr config files is to use the [MAGeCK-VISPR]( workflow. If you don’t want to use the workflow, you can manually create a VISPR config by issueing

vispr config

to obtain a template for modification.

### Step 3: Running VISPR

Once you have a config file (either generated by the workflow or manually), you can issue

vispr server path/to/config.yaml

to start a server process that renders the VISPR user interface in a webbrowser. VISPR can be invoked with multiple config files (i.e. multiple experiments), allowing to select and compare experiments via the user interface.

Further, you can compress results into an archive that can easily be sent via email:

vispr archive path/to/config.yaml myexperiment.tar.bz2

Then, even on a different workstation, the results can be extracted and visualized with VISPR:

tar -xf myexperiment.tar.bz2 vispr server myexperiment/vispr.yaml

For further help, explore all command line options of VISPR with

vispr –help


Johannes Köster <>


Licensed under the MIT license ( This project may not be copied, modified, or distributed except according to those terms.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
vispr-0.4.6.tar.gz (318.8 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page