Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 1.93 KB

README.md

File metadata and controls

51 lines (36 loc) · 1.93 KB
Raw

Clustergrammer-Widget

This is a Jupyter/IPython interactive widget implementation of the interactive heatmap tool Clustergrammer. The front-end visualization, clustergrammer.js is built using D3.js and the back-end, clustergrammer.py is built in Python.

demo_screenshot

Installation

The interactive widget can be installed and enabled using the following commands:

pip install clustergrammer_widget
jupyter nbextension enable --py --sys-prefix widgetsnbextension
jupyter nbextension enable --py --sys-prefix clustergrammer_widget

Dependencies

  • Numpy
  • Scipy
  • Pandas

Clustergrammer-widget is compatable with Python 2 and 3.

Example Workflow

The Clustergrammer-widget can be used to visualize a matrix of your data in the TSV format described here.

Within the Jupyter/IPython notebook the widget can be run using the following commands

# import the widget
from clustergrammer_widget import *

# load data into new network instance and cluster
net = Network(clustergrammer_widget)
net.load_file('rc_two_cats.txt')
net.cluster()

# view the results as a widget
net.widget()

Development Installation

For a development installation (requires npm),

$ git clone https://github.com/maayanlab/clustergrammer-widget.git
$ cd clustergrammer-widget
$ pip install -e .
$ jupyter nbextension install --py --symlink --user clustergrammer_widget
$ jupyter nbextension enable --py --user clustergrammer_widget