https://github.com/gxa/atlas-heatmap
Raw File
Tip revision: 1fcf388f139abab0e92ec3e786cab2e3362fd542 authored by Alfonso Muñoz-Pomer on 19 June 2017, 10:57:50 UTC
2.7.4
Tip revision: 1fcf388
README.md
# Expression Atlas Heatmap

Heatmap visualization of baseline, proteomics baseline and differential gene expression experiments for [Expression
Atlas](http://www.ebi.ac.uk/gxa).

It has four basic visualizations:
* Multiexperiment: collapses several baseline tissue experiments into a single table
* Baseline: displays a single baseline expression experiment
* Proteomics baseline: displays a single proteomics baseline expression experiment
* Differential: displays a single differential expression experiment

Visualizations include, where available, an anatomogram to the left of the table.

## Atlas Widget

Our data can be included as a widget as part of your website.
[Demo](http://www.ebi.ac.uk/gxa/resources/test/widget/showcase/index.html)

#### What you need
You must add the following to your environment:

```
<link rel="stylesheet" type="text/css"
href="http://www.ebi.ac.uk/gxa/resources/css/customized-bootstrap-3.3.5.css"/>
```

If you already use your own flavour of Bootstrap, then you
can remove the styles link tags and the widget will integrate smoothly
in your environment.

Are you targetting es5 or IE11? Include these polyfills for babel-polyfill and whatwg-fetch:
```
<script language="JavaScript" type="text/javascript"
src="${pageContext.request.contextPath}/resources/js/lib/babel-polyfill.min.js"></script>
<script language="JavaScript" type="text/javascript"
src="${pageContext.request.contextPath}/resources/js/lib/fetch-polyfill.min.js"></script>
```

Then include our widget and the vendor bundle:
```
<script language="JavaScript" type="text/javascript"
src="http://www.ebi.ac.uk/gxa/resources/js-bundles/vendorCommons.bundle.js"></script>
<script language="JavaScript" type="text/javascript"
src="http://www.ebi.ac.uk/gxa/resources/js-bundles/expressionAtlasHeatmapHighcharts.bundle.js"></script>
```


Tell us about any problems by raising an issue in this repository.

#### Invoking the widget

You need to call the render method on the exposed global variable:
```
expressionAtlasHeatmapHighcharts.render({
    query: {
      gene: "ASPM"
    },
    isMultiExperiment: true,
    target: "heatmapContainer"
});
```
[Lots of examples](http://www.ebi.ac.uk/gxa/resources/test/widget/showcase/index.html)


#### Building from source

You can also use us as a React component:
```
npm install expression-atlas-heatmap-highcharts
import { ExpressionAtlasHeatmap } from 'expression-atlas-heatmap-highcharts'
```

##### Notes for developers
`imports-loader`, although not strictly needed, is necessary to build the `anatomogram` package and therefore it is
included in `devDependencies`.

The authoritative docs are the code itself, here is the main function: [here](https://github.com/gxa/atlas-heatmap/blob/master/src/Main.jsx)

#### Licence

Apache 2.0.
When including the widget on your website, please keep the attribution footer linking to the results in Expression Atlas.
back to top