bokehheat 0.0.11

A python3 bokeh based boolean data, categorical data, numerical data, dendrogram, and heatmap plotting library.

Bokehheat

Example Results

For the real interactive experience, please clone or download this repository's history/theclusterbar_0.0.11.html and history/theclustermap_0.0.11.html files with your favorite web browser (we recommend FireFox) or install bokehheat and run this tutorial.

Figure 1: This figure shows the static png output from heat.clusterbar and heat.clustermap. The plots were generated with the tutorial below.

Abstract

Bokehheat provides a python3, bokeh based, interactive boolean data, categorical data, numerical data, dendrogram, bar plot, and heatmap plotting implementation.

• Minimal requirement: python >= 3.10, bokeh >= 3.1.0 (numpy 2.0.0 compatible)
• Dependencies: bokeh, ipython, jupyter_bokeh, matplotlib, pandas, scipy, selenium, phantomjs
• Programmer: bue, jenny
• Date origin: 2018-08
• License: >= GPLv3
• User manual: this README file
• Source code: https://gitlab.com/bue/bokehheat

Available bokehheat heat plots are:

• heat.cdendro: an interactive categorical dendrogram plot implementation.
• heat.bbar: an interactive boolean bar plot implementation.
• heat.cbar: an interactive categorical bar plot implementation.
• heat.qbar: an interactive quantitative bar plot implementation.
• heat.stackedbar: an interactive quantitative stacked bar plot implementation.
• heat.heatmap: an interactive heatmap implementation.
• heat.clusterbar (this is your workhorse): an interactive cluster stacked bar implementation that combines heat.cdendro, heat.bbar, heat.cbar, heat.qbar and heat.stackbar under the hood.
• heat.clustermap (this is your workhorse): an interactive cluster heatmap implementation that combines heat.cdendro, heat.bbar, heat.cbar, heat.qbar and heat.heatmap under the hood.

Available bokehheat jheat plots are:

• jheat.jdendro: javatreeview compatible dendrogram gtr, atr file output.
• jheat.jheatmap: javatreeview compatible heatmap cdt file output.
• jheat.jclustermap: javatreeview compatible heatmap cdt, gtr and atr file output, which runs jheat.jdendro and jheat.jheatmap under the hood.

How To Guide

How to install bokehheat?

pip3 install bokehheat

How to load the bokehheat library?

from bokehheat import heat
from bokehheat import jheat

How to integrate bokehheat plots into Jupyter Notebook and Lab?

o_clustermap, ls_xaxis, ls_yaxis = heat.clustermap(s_filename='jupyter')

Reference

This is the technical description of the machinery and how to operate it. References are maintained in each function's docstring.

How to get reference information about how to use each bokehheat module?

from bokehheat import heat

help(heat.cdendro)
help(heat.bbar)
help(heat.cbar)
help(heat.qbar)
help(heat.stackedbar)
help(heat.clusterbar)
help(heat.heatmap)
help(heat.clustermap)

How to get reference information about how to use each javatreeview compatible module?

from bokehheat import jheat

help(jheat.jdendro)
help(jheat.jheatmap)
help(jheat.jclustermap)

Tutorial

This tutorial guides you through a cluster bar and cluster heatmap generation process.

1. Load libraries needed for this tutorial:

   # library
   from bokehheat import heat, jheat
   from bokeh import io # show
   from bokeh import palettes # Viridis256, Reds9, RdBu11, Spectral11, Colorblind8
   import numpy as np
   import pandas as pd
   

2. Prepare data:

   ls_observation = ['sample_A','sample_B','sample_C','sample_D','sample_E','sample_F','sample_G','sample_H']
   ls_variable = ['gene_A','gene_B','gene_C','gene_D','gene_E','gene_F','gene_G','gene_H', 'gene_I']
   
   # generate test data for the heatmap
   ar_z = np.random.rand(9,8)
   df_matrix_map = pd.DataFrame((ar_z - 0.5) * 2)
   df_matrix_map.index = ls_variable
   df_matrix_map.columns = ls_observation
   df_matrix_map.index.name = 'y'
   df_matrix_map.columns.name = 'x'
   
   # generate test data for the stacked bar plot
   a_matrix_bar = np.array([
       [1/45, 2/45, 3/45, 4/45, 5/45, 6/45, 7/45, 9/45],
       [2/45, 3/45, 4/45, 5/45, 6/45, 7/45, 8/45, 1/45],
       [3/45, 4/45, 5/45, 6/45, 7/45, 8/45, 9/45, 2/45],
       [4/45, 5/45, 6/45, 7/45, 8/45, 9/45, 1/45, 3/45],
       [5/45, 6/45, 7/45, 8/45, 9/45, 1/45, 2/45, 4/45],
       [6/45, 7/45, 8/45, 9/45, 1/45, 2/45, 3/45, 5/45],
       [7/45, 8/45, 9/45, 1/45, 2/45, 3/45, 4/45, 6/45],
       [8/45, 9/45, 1/45, 2/45, 3/45, 4/45, 5/45, 7/45],
       [9/45, 1/45, 2/45, 3/45, 4/45, 5/45, 6/45, 8/45],
   ])
   df_matrix_bar = pd.DataFrame(a_matrix_bar, index=ls_variable, columns=ls_observation)
   
   # generate gene color dictionary for the stacked bar plot
   ds_stack_color = {
       # gene
       'gene_A': 'yellow',
       'gene_B': 'olive',
       'gene_C': 'lime',
       'gene_D': 'green',
       'gene_E': 'teal',
       'gene_F': 'cyan',
       'gene_G': 'blue',
       'gene_H': 'navy',
       'gene_I': 'purple',
   }
   
   # generate some gene annotation for the heatmap
   df_variable = pd.DataFrame({
       'y': ls_variable,
       'genereal': list(np.random.random(9) * 2 - 1),
       'genetype': ['Ligand','Ligand','Ligand','Ligand','Ligand','Ligand','Receptor','Receptor','Receptor'],
       'genetype_color': ['Cyan','Cyan','Cyan','Cyan','Cyan','Cyan','Cornflowerblue','Cornflowerblue','Cornflowerblue'],
       'geneboole': [False, False, False, True, True, True, False, False, False],
   })
   df_variable.index = df_variable.y  # note: this dataframe index has to match either the df_matrix_map.index or df_matrix_map.columns labels!
   
   # generate some sample annotation for the heatmap and stacked bar plot
   df_observation = pd.DataFrame({
       'x': ls_observation,
       'age_year': list(np.random.randint(0,101, 8)),
       'sampletype': ['LumA','LumA','LumA','LumB','LumB','Basal','Basal','Basal'],
       'sampletype_color': ['Purple','Purple','Purple','Magenta','Magenta','Orange','Orange','Orange'],
       'sampleboole': [False, False, True, True, True, True, False, False],
   })
   df_observation.index = df_observation.x  # note: this dataframe index has to match either the df_matrix_map.index or df_matrix_map.columns labels!
   

3. Generate categorical and quantitative sample and gene annotation tuple of tuples:

   t_yboole = (df_variable, ['geneboole'],'Red','Maroon') # True, False
   t_ycat = (df_variable, ['genetype'], ['genetype_color'])
   t_yquant = (df_variable, ['genereal'], [-1], [1], [palettes.Colorblind8][::-1])
   
   t_xboole = (df_observation, ['sampleboole'],'Red','Maroon') # True, False
   t_xcat = (df_observation, ['sampletype'], ['sampletype_color'])
   t_xquant = (df_observation, ['age_year'], [0], [128], [palettes.YlGn8][::-1])
   
   tt_boolecatquant_bar = (t_xquant, t_xcat, t_xboole)
   tt_boolecatquant_map = (t_yboole, t_ycat, t_yquant, t_xboole, t_xcat, t_xquant)
   

4. Generate the cluster bar:

   s_file = "theclusterbar.html"  # or "theclusterbar.png"
   o_clusterbar, ls_axis = heat.clusterbar(
       df_matrix = df_matrix_bar,
       ds_stack_color = ds_stack_color,
       b_sum_to_1 = True,
       tt_axis_annot = tt_boolecatquant_bar,
       b_dendro = True,
       #s_method = 'average',
       #s_metric = 'euclidean',
       #b_optimal_ordering = False,
       #i_px = 64,
       #i_height = 12,
       #i_width = 12,
       #i_min_border_px = 128,
       s_filename = s_file,
       s_filetitle = 'the Clusterbar',
   )
   

5. Display the cluster bar result:

   print(f"check out: {s_file}")
   print(f"axis is: {ls_axis}")
   
   io.show(o_clusterbar)
   

6. Generate the cluster heatmap:

   s_file = "theclustermap.html"  # or "theclustermap.png"
   o_clustermap, ls_xaxis, ls_yaxis = heat.clustermap(
       df_matrix = df_matrix_map,
       ls_color_palette = heat.coolwarm256,  # heat.seismic256, heat.red256
       r_low = -1,
       r_high = 1,
       s_z = "log2",
       tt_axis_annot = tt_boolecatquant_map,
       b_ydendro = True,
       b_xdendro = True,
       #s_method='average',
       #s_metric='euclidean',
       #b_optimal_ordering=False,
       #i_px = 64,
       #i_height = 12,
       #i_width = 12,
       #i_min_border_px = 128,
       s_filename=s_file,
       s_filetitle="the Clustermap",
   )
   

7. Display the cluster heatmap result:

   print(f"check out: {s_file}")
   print(f"y axis is: {ls_yaxis}")
   print(f"x axis is: {ls_xaxis}")
   
   io.show(o_clustermap)
   

   The resulting clustermap should look something like the example result in the section above.

8. Generate cdt, gtr, atr files to be able to study heatmap and clustering in the JavaTreeView and TreeView3 software.

   t_out = jheat.jclustermap(
       df_matrix=df_matrix_map,
       tt_axis_annot = tt_boolecatquant_map,
       s_xcolor = "age_year",
       s_ycolor = "genetype",
       b_xdendro = True,
       b_ydendro = True,
       #s_method = 'average',
       #s_metric = 'euclidean',
       #b_optimal_ordering = False,
       s_filename = "jclustermap",
   )
   print(t_out)
   

Discussion

In bioinformatics, a clustered heatmap is a common plot to present gene expression data from many patient samples. There are well established open source clustering software kits like Cluster and TreeView, JavaTreeView, and TreeView3 for producing and investigating such heatmaps.

Static cluster heatmap implementations

There exists a wealth of R and R/bioconductor packages with static cluster heatmap functions (e.g. heatmap.2 from the gplots library), each one with its own pros and cons.

In Python, the static cluster heatmap landscape looks much more deserted. There are some ancient mathplotlib based implementations like this active state recipe or the heatmapcluster library or the hclustering library. There is the seaborn clustermap implementation, which looks good but might need hours of tweaking to get an agreeable plot with all the needed information out.

So, static heatmaps are not really a tool for exploring data.

Interactive cluster heatmap implementations

There exists d3heatmap, a R/d3.js based interactive cluster heatmap package. And heatmaply, an R/plotly based package. Or, on a more basic level, R/plotly based cluster heatmaps can be written with the ggdendro and ggplot2 libraries.

But we have not found a full fledged python based interactive cluster heatmap library. Neither Python/plottly nor Python/bokeh based. The only Python/bokeh based cluster heatmap implementation we were really aware of was this listing from Daniel Russo. Later on we found this bokeh based bkheatmap implementation from Wen-Wei Liao.

Synopsis

All in all, all of these implementations were not really what we were looking for. That is why we rolled our own. Bokehheat is a Python3/bokeh based interactive cluster heatmap library.

The challenges this implementation tried to solve are the library should be:

• Easy to use with pandas dataframes.
• Static output: This means there has to be an easy way to generate static png files as output.
• Interactive output: This means there has to be an easy way to generate hoverable and zoomable plots.
• Output should be stored in computer platform independent and easily accessible format, like png files or java script spiced up html file, which can be opened in any web browser.
• Possibility to add as many boolean, categorical, and quantitative y and x annotation bars as wished.
• Possibility to hierarchically cluster the y and/or x axis.
• Snappy interactivity, even with big datasets with lots of samples and genes. (It turns out bokehheat is ok with hundreds of samples and genes but not with thousands. This is why the jheat.py extension was added, to be easily able to generate JavaTreeView and TreeView3 compatible output.)

Further directions

If you are interested in data visualization, check out Jake VanderPlas talk Python Visualization Landscape from the PyCon 2017 in Portland, Oregon (USA).

About Documentaion

Within the bokehheat library, we try to stick to the documentation policy lined out by Daniele Procida in his talk "what nobody tells you about documentation" at PyCon 2017 in Portland, Oregon.

Contributions

• Implementation: Elmar Bucher, Jennifer Eng
• Helpful discussion: Mark Dane, Daniel Derrick, Hongmei Zhang, Annette Kolodize, Koei Chin, Jim Korkola, Laura Heiser, Matt Melnicki, Bryan Van de Ven, and Daniele Procida.

Cite:

@Misc{bucher2018,
  author    = {Bucher, Elmar and Eng, Jennifer},
  title     = {Bokehheat: A Python 3 Bokeh-based, interactive dendrogram, bar plot, and heatmap plotting library.},
  year      = {2018},
  copyright = {Open Access},
  doi       = {10.5281/zenodo.19039521},
  publisher = {Zenodo},
}