kanhayaKy / clustergrammer

WebGL Clustergrammer JavaScript Library

About

Clustergrammer, Clustergrammer2, and Clustergrammer-GL are packages originally developed by the Human Immune Monitoring Center and Ma'ayan lab at the Icahn School of Medicine at Mount Sinai.

This work is now being continued by Gumus Lab, also at ISMMS, and the code is being updated and maintained so it can be used in genomics project that the Gumus Lab is working on.

The project lead is Kevin Ulrich, who can be contacted here.

The original documentation for Clustergrammer and all its associated projects is located here, though it mainly applies in terms of creating formatted data with Clustergrammer-PY and the desired format for the data for Javascript applications.

Setup for Local Development

1. Clone the code to your local machine
2. Run yarn to install all required node modules
3. Run yarn build-for-example to build the package locally into the example/example-app folder
4. cd example/example-app and yarn start to start the local test app
5. After you make changes to the code, re-run yarn build-for-example and refresh the webpage to see the changes

Licensing

The original license still applies, and the code is MIT-licensed.