Skip to content

Annotated heatmap #359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cldougl merged 12 commits into from
Nov 26, 2015
Merged

Annotated heatmap #359

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
93e334b
Add tables and annotated heatmaps to FigureFactory
cldougl Nov 20, 2015
990041a
add validations and tests
cldougl Nov 25, 2015
84ade7c
add examples to docstring
cldougl Nov 25, 2015
a669408
naming edits
cldougl Nov 25, 2015
52eebf1
update tests based on var name updates
cldougl Nov 25, 2015
d40621a
edit table margin and height formula
cldougl Nov 25, 2015
27f8efa
edits from review
cldougl Nov 25, 2015
af5e0e5
updates from review
cldougl Nov 26, 2015
f5badba
update tests
cldougl Nov 26, 2015
29452a0
add `list()` for python3
cldougl Nov 26, 2015
704e7af
Update CHANGELOG.md
cldougl Nov 26, 2015
e77c055
bump version
cldougl Nov 26, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
299 changes: 299 additions & 0 deletions plotly/tests/test_core/test_tools/test_figure_factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -686,6 +686,305 @@ def test_datetime_candlestick(self):
self.assertEqual(candle, exp_candle)


class TestAnnotatedHeatmap(TestCase):

def test_unequal_z_text_size(self):

# check: PlotlyError if z and text are not the same dimmensions
Copy link
Contributor

@theengineear theengineear Nov 26, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🐐 dimension


kwargs = {'z': [[1, 2], [1, 2]], 'text': [[1, 2, 3], [1, 2]]}
self.assertRaises(PlotlyError,
tls.FigureFactory.create_annotated_heatmap,
**kwargs)

kwargs = {'z': [[1, 2], [1, 2]], 'text': [[1, 2], [1, 2], [1, 2]]}
self.assertRaises(PlotlyError,
tls.FigureFactory.create_annotated_heatmap,
**kwargs)

def test_simple_annotated_heatmap(self):

# we should be able to create a heatmap with annotated values with a
# logical text color

z = [[1, 0, .5], [.25, .75, .45]]
a_heat = tls.FigureFactory.create_annotated_heatmap(z)
expected_a_heat = {
'data': [{'showscale': False,
'type': 'heatmap',
'z': [[1, 0, 0.5], [0.25, 0.75, 0.45]]}],
'layout': {'annotations': [{'font': {'color': '#000000'},
'showarrow': False,
'text': '1',
'x': 0,
'xref': 'x1',
'y': 0,
'yref': 'y1'},
{'font': {'color': '#FFFFFF'},
'showarrow': False,
'text': '0',
'x': 1,
'xref': 'x1',
'y': 0,
'yref': 'y1'},
{'font': {'color': '#000000'},
'showarrow': False,
'text': '0.5',
'x': 2,
'xref': 'x1',
'y': 0,
'yref': 'y1'},
{'font': {'color': '#FFFFFF'},
'showarrow': False,
'text': '0.25',
'x': 0,
'xref': 'x1',
'y': 1,
'yref': 'y1'},
{'font': {'color': '#000000'},
'showarrow': False,
'text': '0.75',
'x': 1,
'xref': 'x1',
'y': 1,
'yref': 'y1'},
{'font': {'color': '#000000'},
'showarrow': False,
'text': '0.45',
'x': 2,
'xref': 'x1',
'y': 1,
'yref': 'y1'}],
'xaxis': {'gridcolor': 'rgb(0, 0, 0)',
'showticklabels': False,
'side': 'top',
'ticks': ''},
'yaxis': {'showticklabels': False, 'ticks': '',
'ticksuffix': ' '}}}
self.assertEqual(a_heat, expected_a_heat)

def test_more_kwargs(self):

# we should be able to create an annotated heatmap with x and y axes
# lables, a defined colorscale, and supplied text.

z = [[1, 0], [.25, .75], [.45, .5]]
text = [['first', 'second'], ['third', 'fourth'], ['fifth', 'sixth']]
a = tls.FigureFactory.create_annotated_heatmap(z,
x=['A', 'B'],
y=['One', 'Two',
'Three'],
text=text,
colorscale=[[0,
'#ffffff'],
[1,
'#e6005a']]
)
expected_a = {'data': [{'colorscale': [[0, '#ffffff'], [1, '#e6005a']],
'showscale': False,
'type': 'heatmap',
'x': ['A', 'B'],
'y': ['One', 'Two', 'Three'],
'z': [[1, 0], [0.25, 0.75], [0.45, 0.5]]}],
'layout': {'annotations': [{'font': {'color': '#FFFFFF'},
'showarrow': False,
'text': 'first',
'x': 'A',
'xref': 'x1',
'y': 'One',
'yref': 'y1'},
{'font': {'color': '#000000'},
'showarrow': False,
'text': 'second',
'x': 'B',
'xref': 'x1',
'y': 'One',
'yref': 'y1'},
{'font': {'color': '#000000'},
'showarrow': False,
'text': 'third',
'x': 'A',
'xref': 'x1',
'y': 'Two',
'yref': 'y1'},
{'font': {'color': '#FFFFFF'},
'showarrow': False,
'text': 'fourth',
'x': 'B',
'xref': 'x1',
'y': 'Two',
'yref': 'y1'},
{'font': {'color': '#FFFFFF'},
'showarrow': False,
'text': 'fifth',
'x': 'A',
'xref': 'x1',
'y': 'Three',
'yref': 'y1'},
{'font': {'color': '#FFFFFF'},
'showarrow': False,
'text': 'sixth',
'x': 'B',
'xref': 'x1',
'y': 'Three',
'yref': 'y1'}],
'xaxis': {'gridcolor': 'rgb(0, 0, 0)',
'side': 'top', 'ticks': ''},
'yaxis': {'ticks': '', 'ticksuffix': ' '}}}
self.assertEqual(a, expected_a)


class TestTable(TestCase):

def test_fontcolor_input(self):

# check: PlotlyError if fontcolor input is incorrect

kwargs = {'text': [['one', 'two'], [1, 2], [1, 2], [1, 2]],
'fontcolor': '#000000'}
self.assertRaises(PlotlyError,
tls.FigureFactory.create_table, **kwargs)

kwargs = {'text': [['one', 'two'], [1, 2], [1, 2], [1, 2]],
'fontcolor': ['red', 'blue']}
self.assertRaises(PlotlyError,
tls.FigureFactory.create_table, **kwargs)

def test_simple_table(self):

# we should be able to create a striped table by suppling a text matrix

text = [['Country', 'Year', 'Population'], ['US', 2000, 282200000],
['Canada', 2000, 27790000], ['US', 1980, 226500000]]
table = tls.FigureFactory.create_table(text)
expected_table = {'data': [{'colorscale': [[0, '#66b2ff'], [0.5, '#e6e6e6'], [1, '#ffffff']],
'opacity': 0.7,
'showscale': False,
'type': 'heatmap',
'z': [[0, 0, 0], [0.5, 0.5, 0.5], [1, 1, 1], [0.5, 0.5, 0.5]]}],
'layout': {'annotations': [{'align': 'left',
'font': {'color': '#000000'},
'showarrow': False,
'text': '<b>Country</b>',
'x': -0.45,
'xanchor': 'left',
'xref': 'x1',
'y': 0,
'yref': 'y1'},
{'align': 'left',
'font': {'color': '#000000'},
'showarrow': False,
'text': '<b>Year</b>',
'x': 0.55,
'xanchor': 'left',
'xref': 'x1',
'y': 0,
'yref': 'y1'},
{'align': 'left',
'font': {'color': '#000000'},
'showarrow': False,
'text': '<b>Population</b>',
'x': 1.55,
'xanchor': 'left',
'xref': 'x1',
'y': 0,
'yref': 'y1'},
{'align': 'left',
'font': {'color': '#000000'},
'showarrow': False,
'text': 'US',
'x': -0.45,
'xanchor': 'left',
'xref': 'x1',
'y': 1,
'yref': 'y1'},
{'align': 'left',
'font': {'color': '#000000'},
'showarrow': False,
'text': '2000',
'x': 0.55,
'xanchor': 'left',
'xref': 'x1',
'y': 1,
'yref': 'y1'},
{'align': 'left',
'font': {'color': '#000000'},
'showarrow': False,
'text': '282200000',
'x': 1.55,
'xanchor': 'left',
'xref': 'x1',
'y': 1,
'yref': 'y1'},
{'align': 'left',
'font': {'color': '#000000'},
'showarrow': False,
'text': 'Canada',
'x': -0.45,
'xanchor': 'left',
'xref': 'x1',
'y': 2,
'yref': 'y1'},
{'align': 'left',
'font': {'color': '#000000'},
'showarrow': False,
'text': '2000',
'x': 0.55,
'xanchor': 'left',
'xref': 'x1',
'y': 2,
'yref': 'y1'},
{'align': 'left',
'font': {'color': '#000000'},
'showarrow': False,
'text': '27790000',
'x': 1.55,
'xanchor': 'left',
'xref': 'x1',
'y': 2,
'yref': 'y1'},
{'align': 'left',
'font': {'color': '#000000'},
'showarrow': False,
'text': 'US',
'x': -0.45,
'xanchor': 'left',
'xref': 'x1',
'y': 3,
'yref': 'y1'},
{'align': 'left',
'font': {'color': '#000000'},
'showarrow': False,
'text': '1980',
'x': 0.55,
'xanchor': 'left',
'xref': 'x1',
'y': 3,
'yref': 'y1'},
{'align': 'left',
'font': {'color': '#000000'},
'showarrow': False,
'text': '226500000',
'x': 1.55,
'xanchor': 'left',
'xref': 'x1',
'y': 3,
'yref': 'y1'}],
'height': 320,
'xaxis': {'dtick': 1,
'gridwidth': 2,
'showticklabels': False,
'tick0': -0.5,
'ticks': '',
'zeroline': False},
'yaxis': {'autorange': 'reversed',
'dtick': 1,
'gridwidth': 2,
'showticklabels': False,
'tick0': 0.5,
'ticks': '',
'zeroline': False}}}

Copy link
Contributor

@theengineear theengineear Nov 26, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🐄 Also, looks like the following tests are commented out below? Any insights?

Copy link
Member Author

@cldougl cldougl Nov 26, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@theengineear yep- this one was commented out because it was failing to fail on circle- apparently scipy was imported when the test_core tests were run.

Copy link
Contributor

@theengineear theengineear Nov 26, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome. Not sure who commented it (was it me?), but in the future, we should skip the whole TestCase with a good "skip reason" if we intend for this test to be run again, and that reason should point to an issue in the repo. Otherwise, we should delete it rather than comment it out.

Copy link
Member Author

@cldougl cldougl Nov 26, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope- I think it was me. Ok, That sounds like a better plan!

# class TestDistplot(TestCase):

# def test_scipy_import_error(self):
Expand Down
Loading