Jupyter Notebook HTML Python Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
clustergrammer_widget 1.13.3, fixed rendering of unclustered heatmap Mar 14, 2018
img added git, working on adding it to the README Mar 19, 2018
js updated package.lock Mar 14, 2018
.gitignore widget working in big mack Sep 20, 2016
DataFrame_Example.ipynb updated example notebooks Apr 5, 2017
LICENSE added license Feb 17, 2017
MANIFEST.in first commit of clustergrammer_widget, working on bringing in cluster… Jul 25, 2016
Python 3.5 test.ipynb updated example notebooks Apr 5, 2017
README.md set up readme markdown to show gif Mar 19, 2018
RELEASE.md updating version numbers on npm Aug 10, 2017
Running_clustergrammer_widget.html added html notebook example Apr 10, 2018
Running_clustergrammer_widget.ipynb using clustergrammer v1.19.4 with new version of mathjs Dec 20, 2017
Working_on_new_API.ipynb using new API in Running_clustergrammer_widget.ipynb example Mar 30, 2017
new_notebook.ipynb new notebook with new API Mar 30, 2017
notes.txt added d3 external as node module, using it in example.js with require… Jul 28, 2016
rc_two_cats.txt changed name of main python module from clustergrammer_notebook to cl… Feb 8, 2017
requirements.txt added sklearn Aug 24, 2017
setup.cfg first commit of clustergrammer_widget, working on bringing in cluster… Jul 25, 2016
setup.py first commit of clustergrammer_widget, working on bringing in cluster… Jul 25, 2016
tmp-API-check.ipynb made new notbook tmp-API-check for nbviewer check Mar 30, 2017

README.md

Clustergrammer-Widget

This is a Jupyter notebook 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.

Please refer to the Clustergrammer-Widget documentation for more information or click on the screenshot below to see an example notebook.

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()

Case Studies and Examples

The Clustergrammer-Widget has been applied to a wide variety of biological and non-biological data. Refer to the Jupyter notebook examples below and Case Studies and Examples for more information:

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