search

eweitz / ideogram

Chromosome visualization for the web
https://eweitz.github.io/ideogram
Other
294 stars 71 forks source link
cancer-genomics comparative-genomics cytogenetics genomics karyotype personal-genomics visualization

readme

ideogram

Tests Coverage status

Ideogram.js is a JavaScript library for chromosome visualization.

Ideogram supports drawing and animating genome-wide datasets for human, mouse, and many other eukaryotes. The Ideogram API for annotations supports histograms, heatmaps, overlays, and points of arbitrary shape and color layered in tracks. Ideogram can depict haploid, diploid or higher ploidy genomes (e.g. plants), as well as aneuploidy, genetic recombination, and homologous features between chromosomes.

Ideogram can be embedded as a reusable component in any web page or application, and leverages D3.js and SVG to achieve fast, crisp client-side rendering. You can also integrate Ideogram with JavaScript frameworks like Angular, React, and Vue, as well as data science platforms like R and Jupyter Notebook.

All human genes

Check out live examples, get up and running with your own deployment, skim basic usage, or dive into the full API!

A broader overview is also available. It discusses Ideogram's chromosome biology, technical architecture, and more.

Installation

To link directly to the latest release, copy this snippet:

<script src="https://cdn.jsdelivr.net/npm/ideogram@1.48.0/dist/js/ideogram.min.js"></script>

You can also easily use the library locally:

$ cd <your local web server document root>
$ git clone https://github.com/eweitz/ideogram.git

Then go to http://localhost/ideogram/examples/.

Or, if you use npm:

npm install ideogram

You can then import Ideogram into an application like so:

import Ideogram from 'ideogram';

Usage

<head>
  <script src="https://cdn.jsdelivr.net/npm/ideogram@1.48.0/dist/js/ideogram.min.js"></script>
</head>
<body>
<script>
  var ideogram = new Ideogram({
    organism: 'human',
    annotations: [{
      name: 'BRCA1',
      chr: '17',
      start: 43044294,
      stop: 43125482
    }]
  });
</script>
</body>

Many more usage examples are available at https://eweitz.github.io/ideogram/.

You can also find examples of integrating Ideogram with JavaScript frameworks like Angular, React, and Vue, as well as data science platforms like R and Jupyter Notebook.

API

See the Ideogram API reference for detailed documentation on configuration options and methods.