Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 1.59 KB

README.md

File metadata and controls

35 lines (28 loc) · 1.59 KB

FunkyHeatmap.js

{funkyheatmap} allows generating heatmap-like visualisations for data frames. Funky heatmaps can be fine-tuned by providing annotations of the columns and rows, which allow assigning multiple palettes or geometries or grouping rows and columns together in categories.

This is an interactive JavaScript adaptation of funkyheatmap R package to the browser with d3.js.

Installation

If you want to add {funkyheatmap} to your website, you can include d3.js, lodash and funkyheatmapjs from unpkg or other service serving npm packages.

<script type="text/javascript" src="https://unpkg.com/d3@7"></script>
<script type="text/javascript" src="https://unpkg.com/lodash@4/lodash.min.js"></script>
<script type="module" src="https://unpkg.com/funkyheatmapjs"></script>

If you have an npm project, you can install npm package funkyheatmapjs with npm or yarn.

Usage

funkyheatmapjs is meant to be used in browser, please see [tutorials]{@tutorial simple} and [documentation]{@link funkyheatmap}.

If you want to use it with npm and have trouble, please open an issue. An example build with parcel can be found here.

Contributing

Please, feel free to open issues for bugs, feature requests and questions, and submit pull requests.