Fast large scale matrix visualization for the web.
Branch: develop
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add issue template Jun 14, 2016
app Fix horizontal multivec tiles Feb 16, 2019
docs Added dt=chromsizes/gene-annotations to docs/higlass-server (#559) Feb 11, 2019
scripts Mccalluc/minimal linting (#457) Dec 6, 2018
sketches Added viridis colormap, style fixes and replaced index.html with it's… Aug 29, 2018
test Fix multiple track addition test failures (#555) Feb 4, 2019
.babelrc Update packages and switch to babel-env Apr 20, 2018
.editorconfig Add editor config Aug 22, 2017
.eslintignore Merge branch 'develop' into flekschas/add-lint-hook Jan 28, 2019
.eslintrc Merge branch 'develop' into flekschas/add-lint-hook Jan 28, 2019
.gitignore Merge branch 'develop' into flekschas/add-lint-hook Jan 28, 2019
.huskyrc Switch to production lint-stage. Add separate commands for proper and… Dec 11, 2018
.lintstagedrc Merge branch 'develop' into flekschas/add-lint-hook Jan 28, 2019
.npmrc Added .npmrc Jun 22, 2018
.tern-project Working multiple diagonal heatmaps Aug 10, 2016
.travis.yml Switched position of -f tag Nov 28, 2018
CHANGELOG.md Use chromsizes from cooler files (#553) Feb 3, 2019
COMMANDS Update docs build commands (#550) Feb 3, 2019
LICENSE Initial commit Apr 12, 2016
PULL_REQUEST_TEMPLATE.md Update PULL_REQUEST_TEMPLATE.md Nov 26, 2018
README.md Merge branch 'develop' into flekschas/add-lint-hook Jan 28, 2019
karma.conf.js Fixed linting errors Feb 4, 2019
package-lock.json 1.4.1 Feb 4, 2019
package.json 1.4.1 Feb 4, 2019
travis_build_test.sh Merge branch 'develop' into flekschas/add-lint-hook Jan 28, 2019
webpack.config.js Pkerpedjiev/default options (#452) Dec 4, 2018

README.md

Build Status Live Docs DOI Slack

Introduction

HiGlass is a web-based viewer for genome interaction maps featuring synchronized navigation of multiple views as well as continuous zooming and panning for navigation across genomic loci and resolutions. It supports visual comparison of Hi-C and other genomic data from different experimental conditions and can be used to efficiently identify salient outcomes of experimental perturbations, generate new hypotheses, and share the results with the community.

A live instance can be found at http://higlass.io. A Docker container is available for running an instance locally, although we recommend using the higlass-manage package to start, stop and configure local instances.

For documentation about how to use and install HiGlass, please visit http://docs.higlass.io.

Citation

Kerpedjiev, P., Abdennur, N., Lekschas, F., McCallum, C., Dinkla, K., Strobelt, H., ... & Gehlenborg, N. HiGlass: Web-based Visual Exploration and Analysis of Genome Interaction Maps. Genome Biology (2018): 19:125. https://doi.org/10.1186/s13059-018-1486-1

Example

Development

To run higlass from its source code simply run the following:

npm install
npm run start

This starts a server in development mode at http://localhost:8080/.

Once started, a list of the examples can be found at http://localhost:8080/examples.html. Template viewconfs located at /docs/examples/viewconfs can viewed directly at urls such as http://localhost:8080/apis/svg.html?/viewconfs/overlay-tracks.json.

Tests

The tests for the React components and API functions are located in the test directory. To save time and only run relevant tests, open karma.conf.js and select the test files to run before running test-watch.

npm run test-watch

Troubleshooting:

  • If the installation fails due to sharp > node-gyp try installing the node packages using python2:

    npm i --python=/usr/bin/python2 && rm -rf node_modules/node-sass && npm i
    

API

HiGlass provides an API for controlling the component from within a Javascript script. Complete documentation is availabe at docs.higlass.io. Example:

<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" type="text/css">
<link rel="stylesheet" href="https://unpkg.com/higlass@1.0.1/dist/styles/hglib.css" type="text/css">

<script src="https://cdnjs.cloudflare.com/ajax/libs/react/15.6.2/react.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/react-dom/15.6.2/react-dom.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/pixi.js/4.6.2/pixi.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/react-bootstrap/0.31.0/react-bootstrap.min.js"></script>
<script src="https://unpkg.com/higlass@1.0.1/dist/scripts/hglib.js"></script>

<div
    id="development-demo"
    style="position: absolute; left: 1rem; top: 1rem; bottom: 1rem; right: 1rem">
</div>

<script>
const api = hglib.createHgComponent(
    document.getElementById('development-demo'),
    'http://higlass.io/api/v1/viewconfs/?d=default',
    { bounded: true }
);
</script>

Related

diagram of related tools

License

HiGlass is provided under the MIT License.