baciphacs.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
Bar Charts In  Pure HTML And CSS.

Copyright (c) 2013, Thibauld Nion

All rights reserved.


Except for the "yapsy" icon, the program is licensed under the "new"
BSD license (see text below).


Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""

__version__ = "1.0"

from collections import namedtuple
import math

DataSample = namedtuple("DataSample","label value stdev")


def GenerateHTMLHorizontalBar(relWidth,relErrorWidth,color):
  """Generate the HTML code of an horizontal bar included in a potentially wider chart.
  'relWidth': amplitude of the bar as a proportion of the full chart's width (between 0 and 1)
  'relErrorWidth': proportion of the error margin wrt to the full chart's width.
  'color': the color to give to the bar.
  The error margin is shown before and after the tip of the bar.
  Pre-condition:
    - relWidth+relErrorWidth<=1.
    - color is a valid HTML color (a color name or a code starting with '#')
  """
  if not (0. <= relWidth <= 1.):
    raise ValueError("Invalid relwidth '%s', it must be between 0 and 1" % relWidth)
  if not (0. <= relErrorWidth <= 1.):
    raise ValueError("Invalid relwidth '%s', it must be between 0 and 1" % relErrorWidth)
  if relWidth+relErrorWidth>1.:
    raise ValueError("Invalid relwidth and relErrorwidth (%s,%s), their sum must not be greater than one" % (relErrorWidth,relErrorWidth))
  # use floor to amplify a little the error bar
  firstPartWidth = math.floor(100*min(1.,max(0,relWidth-relErrorWidth)))
  secondPartWidth = 100*relWidth-firstPartWidth
  thirdPartWidth = min(math.ceil(100*relErrorWidth),100-secondPartWidth-firstPartWidth)
  return """\
<table cellspacing="0" cellpadding="0" border="0" style="width:100%%">
<tr>
  <td style="width:%.0f%%;height:1ex;background-color:%s;"></td>
  <td style="width:%.0f%%;height:1ex;background-color:%s;text-align:left">|</td>
  <td style="width:%.0f%%;height:1ex;text-align:right">|</td>
  <td></td>
</tr>
</table>""" % (firstPartWidth,color,secondPartWidth,color,thirdPartWidth)

def GenerateHTMLLabelledRow(label,title,htmlRowData):
  """Generate a <tr> row with the given label and data.
  'label': a string to be set at the begining of the row.
  'title': the title associated to the full row (typically visible in a tooltip)
  'htmlRowData': the html content to be put next to the label (in a <td> tag)
  Note: the htmlRowData will be indented appropriately.
  Pre-condition:
    - label is valid HTML code.
    - title is a valid string to go into an HTML tag 'title' attribute
    - row data is valid HTML code (that will be encloded in a <td> tag)
  """
  return """\
<tr title="%s">
  <th style="padding-top:.5ex;padding-right:1ex;text-align:right;">%s</th>
  <td style="padding-top:.5ex;width:100%%;">
%s
  </td>
</tr>""" % (title,label,"\n".join("    %s"%line for line in htmlRowData.splitlines()))

def GenerateHTMLHorizontalBarChart(dataSamples,numStdev,color):
  """Generate the code of an HTML table showing one horizontal bar for each data sample.
  Error bars are also shown for each dataSample at 'value+/-(numStdev*stdev)'.
  'dataSamples': a list of Datasample instances.
  'numStdev': the size of the error margin as a number of each sample's standard deviation.
  'color': the HTML color to give to the bars.
  Pre-conditions:
  - the labels of the data samples must be valid HTML code
  - numStdev must be positive
  - color must be a valid HTML color name or code.
  """
  if numStdev<0:
    raise ValueError("numStdev is negative (%s) but it is expected be positive" % numStdev)
  norm = max(ds.value+(numStdev*ds.stdev) for ds in dataSamples)
  bars = [ GenerateHTMLHorizontalBar(float(d.value)/norm,float(numStdev*d.stdev)/norm,color) for d in dataSamples ]
  return """\
<table cellspacing="0" cellpadding="0" border="0" style="width:80ex;font-family:monospace;">
%s
</table>""" % "\n".join([GenerateHTMLLabelledRow(d.label,"%s(+/-%s)"%(d.value,numStdev*d.stdev),b) for d,b in zip(dataSamples,bars)])