Browse Source

Merge remote-tracking branch 'jeffreystarr/add-boxplot'

pull/98/head
Florian Mounier 11 years ago
parent
commit
dc8622cba8
  1. 3
      pygal/graph/__init__.py
  2. 178
      pygal/graph/box.py
  3. 62
      pygal/test/test_box.py
  4. 4
      pygal/test/test_config.py
  5. 4
      pygal/test/test_graph.py

3
pygal/graph/__init__.py

@ -39,5 +39,6 @@ CHARTS_NAMES = [
'DateY',
'Worldmap',
'SupranationalWorldmap',
'Histogram'
'Histogram',
'Box'
]

178
pygal/graph/box.py

@ -0,0 +1,178 @@
# -*- coding: utf-8 -*-
# This file is part of pygal
#
# A python svg graph plotting library
# Copyright © 2012-2013 Kozea
#
# This library is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option) any
# later version.
#
# This library is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with pygal. If not, see <http://www.gnu.org/licenses/>.
"""
Box plot
"""
from __future__ import division
from pygal.graph.graph import Graph
from pygal.util import compute_scale, decorate
from math import floor
class Box(Graph):
"""
Box plot
For each series, shows the median value, the 25th and 75th percentiles, and the values within
1.5 times the interquartile range of the 25th and 75th percentiles.
See http://en.wikipedia.org/wiki/Box_plot
"""
_series_margin = .06
def __init__(self, *args, **kwargs):
super(Box, self).__init__(*args, **kwargs)
def _compute(self):
"""
Compute parameters necessary for later steps within the rendering process
"""
# Note: this code was copied from Bar graph
if self._min:
self._box.ymin = min(self._min, self.zero)
if self._max:
self._box.ymax = max(self._max, self.zero)
x_pos = [
x / self._len for x in range(self._len + 1)
] if self._len > 1 else [0, 1] # Center if only one value
self._points(x_pos)
y_pos = compute_scale(
self._box.ymin, self._box.ymax, self.logarithmic, self.order_min
) if not self.y_labels else map(float, self.y_labels)
self._x_labels = self.x_labels and list(zip(self.x_labels, [
(i + .5) / self._len for i in range(self._len)]))
self._y_labels = list(zip(map(self._format, y_pos), y_pos))
def _plot(self):
"""
Plot the series data
"""
for index, serie in enumerate(self.series):
self._boxf(self._serie(index), serie, index)
def _boxf(self, serie_node, serie, index):
"""
For a specific series, draw the box plot.
"""
# Note: q0 and q4 do not literally mean the zero-th quartile and the fourth quartile, but rather
# the distance from 1.5 times the inter-quartile range to Q1 and Q3, respectively.
q0, q1, q2, q3, q4 = self._box_points(serie.values)
boxes = self.svg.node(serie_node['plot'], class_="boxes")
metadata = serie.metadata.get(0)
box = decorate(
self.svg,
self.svg.node(boxes, class_='box'),
metadata)
val = self._format(q2)
x_center, y_center = self._draw_box(box, (q0, q1, q2, q3, q4), index)
self._tooltip_data(box, val, x_center, y_center, classes="centered")
#print(val)
#self._static_value(box, val, x_center, y_center)
def _draw_box(self, parent_node, quartiles, box_index):
"""
Return the center of a bounding box defined by a box plot. Draws a box plot on self.svg.
"""
width = (self.view.x(1) - self.view.x(0)) / self._len
#x, y = self.view((x, y))
series_margin = width * self._series_margin
#x += series_margin
width -= 2 * series_margin
#height = self.view.y(y_zero) - y
left_edge = self.view.x(0) + width * box_index
# draw lines for whiskers - bottom, median, and top
for whisker in (quartiles[0], quartiles[2], quartiles[4]):
self.svg.line(parent_node,
coords=[(left_edge, self.view.y(whisker)), (left_edge + width, self.view.y(whisker))],
attrib={'stroke-width': 3})
# draw lines connecting whiskers to box (Q1 and Q3)
self.svg.line(parent_node,
coords=[(left_edge + width / 2, self.view.y(quartiles[0])),
(left_edge + width / 2, self.view.y(quartiles[1]))],
attrib={'stroke-width': 2})
self.svg.line(parent_node,
coords=[(left_edge + width / 2, self.view.y(quartiles[4])),
(left_edge + width / 2, self.view.y(quartiles[3]))],
attrib={'stroke-width': 2})
# box, bounded by Q1 and Q3
self.svg.node(parent_node,
tag='rect',
x=left_edge,
y=self.view.y(quartiles[1]),
height=self.view.y(quartiles[3]) - self.view.y(quartiles[1]),
width=width,
attrib={'fill-opacity': 0.25})
return (left_edge + width / 2, self.view.height / 2)
@staticmethod
def _box_points(values):
"""
Return a 5-tuple of Q1 - 1.5 * IQR, Q1, Median, Q3, and Q3 + 1.5 * IQR for a list of numeric values.
The iterator values may include None values.
Uses quartile definition from Mendenhall, W. and Sincich, T. L. Statistics for Engineering and the
Sciences, 4th ed. Prentice-Hall, 1995.
"""
def median(seq):
n = len(seq)
if n % 2 == 0: # seq has an even length
return (seq[n // 2] + s[n // 2 - 1]) / 2
else: # seq has an odd length
return seq[n // 2]
# sort the copy in case the originals must stay in original order
s = sorted([x for x in values if x is not None])
n = len(s)
if not n:
return 0, 0, 0, 0, 0
else:
q2 = median(s)
# See 'Method 3' in http://en.wikipedia.org/wiki/Quartile
if n % 2 == 0: # even
q1 = median(s[:n // 2])
q3 = median(s[n // 2:])
else: # odd
if n == 1: # special case
q1 = s[0]
q3 = s[0]
elif n % 4 == 1: # n is of form 4n + 1 where n >= 1
m = (n - 1) // 4
q1 = 0.25 * s[m-1] + 0.75 * s[m]
q3 = 0.75 * s[3*m] + 0.25 * s[3*m + 1]
else: # n is of form 4n + 3 where n >= 1
m = (n - 3) // 4
q1 = 0.75 * s[m] + 0.25 * s[m+1]
q3 = 0.25 * s[3*m+1] + 0.75 * s[3*m+2]
iqr = q3 - q1
q0 = q1 - 1.5 * iqr
q4 = q3 + 1.5 * iqr
return q0, q1, q2, q3, q4

62
pygal/test/test_box.py

@ -0,0 +1,62 @@
# -*- coding: utf-8 -*-
# This file is part of pygal
#
# A python svg graph plotting library
# Copyright © 2012-2013 Kozea
#
# This library is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option) any
# later version.
#
# This library is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with pygal. If not, see <http://www.gnu.org/licenses/>.
from pygal.graph.box import Box
from pygal import Box as ghostedBox
def test_quartiles():
a = [-2.0, 3.0, 4.0, 5.0, 8.0] # odd test data
q0, q1, q2, q3, q4 = Box._box_points(a)
assert q1 == 7.0 / 4.0
assert q2 == 4.0
assert q3 == 23 / 4.0
assert q0 == 7.0 / 4.0 - 6.0 # q1 - 1.5 * iqr
assert q4 == 23 / 4.0 + 6.0 # q3 + 1.5 * iqr
b = [1.0, 4.0, 6.0, 8.0] # even test data
q0, q1, q2, q3, q4 = Box._box_points(b)
assert q2 == 5.0
c = [2.0, None, 4.0, 6.0, None] # odd with None elements
q0, q1, q2, q3, q4 = Box._box_points(c)
assert q2 == 4.0
d = [4]
q0, q1, q2, q3, q4 = Box._box_points(d)
assert q0 == 4
assert q1 == 4
assert q2 == 4
assert q3 == 4
assert q4 == 4
def test_simple_box():
box = ghostedBox()
box.add('test1', [-1, 2, 3, 3.1, 3.2, 4, 5])
box.add('test2', [2, 3, 5, 6, 6, 4])
box.title = 'Box test'
q = box.render_pyquery()
assert len(q(".axis.y")) == 1
assert len(q(".legend")) == 2
assert len(q(".plot .series rect")) == 2

4
pygal/test/test_config.py

@ -18,7 +18,7 @@
# along with pygal. If not, see <http://www.gnu.org/licenses/>.
from pygal import (
Line, Dot, Pie, Radar, Config, Bar, Funnel, Worldmap,
SupranationalWorldmap, Histogram, Gauge)
SupranationalWorldmap, Histogram, Gauge, Box)
from pygal._compat import u
from pygal.test.utils import texts
from pygal.test import pytest_generate_tests, make_data
@ -270,7 +270,7 @@ def test_no_data():
def test_include_x_axis(Chart):
chart = Chart()
if Chart in (Pie, Radar, Funnel, Dot, Gauge, Worldmap,
SupranationalWorldmap, Histogram):
SupranationalWorldmap, Histogram, Box):
return
if not chart.cls._dual:
data = 100, 200, 150

4
pygal/test/test_graph.py

@ -68,7 +68,9 @@ def test_render_to_png(Chart, datas):
def test_metadata(Chart):
chart = Chart()
v = range(7)
if Chart == pygal.XY:
if Chart in (pygal.Box,):
return # summary charts cannot display per-value metadata
elif Chart == pygal.XY:
v = list(map(lambda x: (x, x + 1), v))
elif Chart == pygal.Worldmap or Chart == pygal.SupranationalWorldmap:
v = list(map(lambda x: x, i18n.COUNTRIES))

Loading…
Cancel
Save