ENH: Add the ability to have a separate title for each subplot when plotting #14753

icanhazcodeplz-zz · 2016-11-26T20:18:16Z

[] tests added / passed
[] passes git diff upstream/master | flake8 --diff
[] whatsnew entry

…each item of the list as the title of the individual subplots.

…lotting.

codecov-io · 2016-11-27T00:39:43Z

Current coverage is 85.26% (diff: 0.00%)

Merging #14753 into master will decrease coverage by 0.01%

@@             master     #14753   diff @@
==========================================
  Files           144        144          
  Lines         50968      50977     +9   
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
+ Hits          43466      43467     +1   
- Misses         7502       7510     +8   
  Partials          0          0

Powered by Codecov. Last update 3ac41ab...59ab880

sinhrks · 2016-11-27T23:52:03Z

pandas/tools/plotting.py

@@ -1217,7 +1217,11 @@ def _adorn_subplots(self):

        if self.title:
            if self.subplots:
-                self.fig.suptitle(self.title)
+                if type(self.title) == list:


pls use is_list_like, and check the input length are correct. Note that all the axes may not require title when you specify layout

Ok I'll use is_list_like. I purposely did not check the lengths as a feature. As it's written, if you only provide a list of two strings, but the plot has 3 suplots, the first two subplots will have a title and the third will be left without one.

sinhrks · 2016-11-27T23:52:50Z

Thx for the PR. can u add tests and release note? Also, pls link the original issue if we have.

…ots' == True and 'title' is a list

icanhazcodeplz-zz · 2016-11-28T23:18:16Z

I did my best at adding a test and release note. I didn't see an original issue that this addresses. It's just something I have on my local that I wanted to contribute.

sinhrks · 2016-11-28T23:51:38Z

pandas/tests/plotting/test_misc.py

+        self.assertEqual([p.title._text for p in plot], title)
+
+        # Case len(title) > len(df)
+        plot = df.plot(subplots=True, title=title + ['Ignore me!'])


I think we should raise if length of passed list and number of axes are different.

Sounds good I added exceptions and pushed. Is ValueError appropriate here?

sinhrks · 2016-11-28T23:52:14Z

pandas/tools/plotting.py

+                    for (ax, title) in zip(self.axes, self.title):
+                        ax.set_title(title)
+                else:
+                    self.fig.suptitle(self.title)
            else:
                self.axes[0].set_title(self.title)


should raise if subplots=False and input is list-like

-raise ValueError if subplots=False and title is of type list

icanhazcodeplz-zz · 2016-12-03T02:28:24Z

Is there anything else I need to do for this change to get pulled in?

sinhrks · 2016-12-06T04:24:27Z

pandas/tools/plotting.py

@@ -1217,8 +1217,22 @@ def _adorn_subplots(self):

        if self.title:
            if self.subplots:
-                self.fig.suptitle(self.title)
+                if is_list_like(self.title):
+                    if len(self.title) != len(self.axes):


pls use self.nseries. Number of columns and axes and can differ when layout is specified.

Also add test case with 3 numeric columns df with df.plot(subplots=True, layout=(2, 2))

sinhrks · 2016-12-06T04:25:13Z

@TomAugspurger pls have a look when you have a time.

TomAugspurger · 2016-12-06T16:12:47Z

doc/source/whatsnew/v0.20.0.txt

@@ -40,7 +40,7 @@ Other enhancements
 ^^^^^^^^^^^^^^^^^^

 - ``pd.read_excel`` now preserves sheet order when using ``sheetname=None`` (:issue:`9930`)
-
+- ``pd.DataFrame.plot`` now prints a title above each subplot if ``suplots=True`` and ``title`` is a list of strings


You can add this PR number in the issue tag (:issue:14753)

TomAugspurger · 2016-12-06T16:18:44Z

pandas/tools/plotting.py

-                self.fig.suptitle(self.title)
+                if is_list_like(self.title):
+                    if len(self.title) != len(self.axes):
+                        msg = 'The length of `title` must equal the number ' \


It'd be nice to report the length of title and the expected number of columns in the error message.

-print out length of title and number of columns in error message

-print out length of title and number of columns in error message -added test case for when layout=(2,2) but number of columns=3

# Conflicts: # doc/source/whatsnew/v0.20.0.txt

TomAugspurger · 2016-12-07T03:15:16Z

pandas/tests/plotting/test_misc.py

+
+        # Case len(title) == len(df)
+        plot = df.plot(subplots=True, title=title)
+        self.assertEqual([p.title._text for p in plot], title)


Sorry, I missed this earlier, but can you use p.get_title() instead of the private matplotlib ._text method. Same thing down on line 300, ax.get_title().

Oh cool I didn't know that existed! Just pushed with the change.

TomAugspurger · 2016-12-07T03:51:51Z

Great thanks. +1 for merge when travis passes. Just ping us if you notice that it's green before we do

icanhazcodeplz-zz · 2016-12-07T15:52:03Z

All green :)

jorisvandenbossche

@bmagnusson few more minor (stylistic) comments

jorisvandenbossche · 2016-12-07T23:00:47Z

pandas/tools/plotting.py

+                        msg = 'The length of `title` must equal the number ' \
+                              'of columns if using `title` of type `list` ' \
+                              'and `subplots=True`.\n' \
+                              'length of title = {}\n' \


Can you use parentheses around the full string instead of \ for the line continuation? (for consistency within the project)

jorisvandenbossche · 2016-12-07T23:00:54Z

pandas/tools/plotting.py

            else:
+                if is_list_like(self.title):
+                    msg = 'Using `title` of type `list` is not supported ' \
+                          'unless `subplots=True` is passed'


jorisvandenbossche · 2016-12-07T23:01:55Z

pandas/tools/plotting.py

-        Title to use for the plot
+    title : string or list
+        If a string is passed, print the string at the top of the figure. If a
+        list is passed and subplots is True, print each item in the


single backticks (`) around 'subplots' (to make it clear that it is a keyword)

jorisvandenbossche · 2016-12-07T23:02:23Z

pandas/tools/plotting.py

-    title : string
-        Title to use for the plot
+    title : string or list
+        If a string is passed, print the string at the top of the figure. If a


Can you leave the starting sentence "Title to use for the plot" ?

…ing. -A few other stylistic changes for consistency.

icanhazcodeplz-zz · 2016-12-08T05:07:14Z

Huh. I assume there is something funny going on since I didn't change any actual code. Is there a way to restart the checks?

…ting.

icanhazcodeplz-zz · 2016-12-08T19:05:24Z

Ah! I figured it out. I had a linting error (I'll start doing lint before committing oops!)

icanhazcodeplz-zz · 2016-12-09T01:01:51Z

All green now! Anything else to change? If not, thanks for all the help everyone! I had fun. This was my first pull request but it certainly won't be the last :).

jorisvandenbossche · 2016-12-09T08:32:47Z

@bmagnusson Thanks! Looking forward to more PRs :-)

* commit 'v0.19.0-174-g81a2f79': (156 commits) BLD: escape GH_TOKEN in build_docs TST: Correct results with np.size and crosstab (pandas-dev#4003) (pandas-dev#14755) Frame benchmarking sum instead of mean (pandas-dev#14824) CLN: lint of test_base.py BUG: Allow TZ-aware DatetimeIndex in merge_asof() (pandas-dev#14844) BUG: GH11847 Unstack with mixed dtypes coerces everything to object TST: skip testing on windows for specific formatting which sometimes hangs (pandas-dev#14851) BLD: try new gh token for pandas-docs CLN/PERF: clean-up of the benchmarks (pandas-dev#14099) ENH: add timedelta as valid type for interpolate with method='time' (pandas-dev#14799) DOC: add section on groupby().rolling/expanding/resample (pandas-dev#14801) TST: add test to confirm GH14606 (specify category dtype for empty) (pandas-dev#14752) BLD: use org name in build-docs.sh BF(TST): use = (native) instead of < (little endian) for target data types (pandas-dev#14832) ENH: Introduce UnsortedIndexError GH11897 (pandas-dev#14762) ENH: Add the ability to have a separate title for each subplot when plotting (pandas-dev#14753) DOC: Fix grammar and formatting typos (pandas-dev#14803) BLD: try new build credentials for pandas-docs TST: Test pivot with categorical data MAINT: Cleanup pandas/src/parser (pandas-dev#14740) ...

release 0.19.1 was from release branch * releases: (156 commits) BLD: escape GH_TOKEN in build_docs TST: Correct results with np.size and crosstab (pandas-dev#4003) (pandas-dev#14755) Frame benchmarking sum instead of mean (pandas-dev#14824) CLN: lint of test_base.py BUG: Allow TZ-aware DatetimeIndex in merge_asof() (pandas-dev#14844) BUG: GH11847 Unstack with mixed dtypes coerces everything to object TST: skip testing on windows for specific formatting which sometimes hangs (pandas-dev#14851) BLD: try new gh token for pandas-docs CLN/PERF: clean-up of the benchmarks (pandas-dev#14099) ENH: add timedelta as valid type for interpolate with method='time' (pandas-dev#14799) DOC: add section on groupby().rolling/expanding/resample (pandas-dev#14801) TST: add test to confirm GH14606 (specify category dtype for empty) (pandas-dev#14752) BLD: use org name in build-docs.sh BF(TST): use = (native) instead of < (little endian) for target data types (pandas-dev#14832) ENH: Introduce UnsortedIndexError GH11897 (pandas-dev#14762) ENH: Add the ability to have a separate title for each subplot when plotting (pandas-dev#14753) DOC: Fix grammar and formatting typos (pandas-dev#14803) BLD: try new build credentials for pandas-docs TST: Test pivot with categorical data MAINT: Cleanup pandas/src/parser (pandas-dev#14740) ...

…lotting (pandas-dev#14753) * Add logic such that if 'title' is a list and 'subplots' is True, use each item of the list as the title of the individual subplots.

icanhazcodeplz-zz added 3 commits November 25, 2016 17:27

Add logic such that if 'title' is a list and 'subplots' is True, use …

3f133ac

…each item of the list as the title of the individual subplots.

ENH: Add the ability to have a separate title for each subplot when p…

55f4667

…lotting.

Merge branch 'master' into plotting

8d1b598

sinhrks reviewed Nov 27, 2016

View reviewed changes

sinhrks added API Design Visualization plotting labels Nov 27, 2016

icanhazcodeplz-zz added 3 commits November 28, 2016 15:03

switch to using 'is_list_like'

ecb9453

add line describing the new titles for subplots feature

d6d1b0c

add tests to check if the titles above subplots are correct if 'subpl…

94ea2d3

…ots' == True and 'title' is a list

sinhrks suggested changes Nov 28, 2016

View reviewed changes

-raise ValueError if len(title) != number of columns.

eb43f25

-raise ValueError if subplots=False and title is of type list

sinhrks suggested changes Dec 6, 2016

View reviewed changes

TomAugspurger requested changes Dec 6, 2016

View reviewed changes

icanhazcodeplz-zz added 4 commits December 6, 2016 18:42

added :issue:14753

5586a96

-use self.nseries instead of len(self.axes)

aa5bb98

-print out length of title and number of columns in error message

-use self.nseries instead of len(self.axes)

2059339

-print out length of title and number of columns in error message -added test case for when layout=(2,2) but number of columns=3

Merge remote-tracking branch 'upstream/master' into plotting

7a293ef

# Conflicts: # doc/source/whatsnew/v0.20.0.txt

TomAugspurger reviewed Dec 7, 2016

View reviewed changes

sinhrks approved these changes Dec 7, 2016

View reviewed changes

use .get_title() instead of .title._text

301cc7d

TomAugspurger approved these changes Dec 7, 2016

View reviewed changes

jorisvandenbossche reviewed Dec 7, 2016

View reviewed changes

-Add 'Title to use for the plot' as the first sentence for the docstr…

5b88951

…ing. -A few other stylistic changes for consistency.

icanhazcodeplz-zz added 2 commits December 8, 2016 10:26

Merge remote-tracking branch 'upstream/master' into plotting

c206daf

Fix 'continuation line under-indented for visual indent' found by lin…

59ab880

…ting.

jorisvandenbossche added this to the 0.20.0 milestone Dec 9, 2016

jorisvandenbossche merged commit 5f057cb into pandas-dev:master Dec 9, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENH: Add the ability to have a separate title for each subplot when plotting #14753

ENH: Add the ability to have a separate title for each subplot when plotting #14753

icanhazcodeplz-zz commented Nov 26, 2016 •

edited

Loading

codecov-io commented Nov 27, 2016 •

edited

Loading

sinhrks Nov 27, 2016

icanhazcodeplz-zz Nov 28, 2016

sinhrks commented Nov 27, 2016

icanhazcodeplz-zz commented Nov 28, 2016

sinhrks Nov 28, 2016

icanhazcodeplz-zz Nov 29, 2016

sinhrks Nov 28, 2016

icanhazcodeplz-zz commented Dec 3, 2016

sinhrks Dec 6, 2016

icanhazcodeplz-zz Dec 7, 2016

sinhrks commented Dec 6, 2016

TomAugspurger Dec 6, 2016

icanhazcodeplz-zz Dec 7, 2016

TomAugspurger Dec 6, 2016

icanhazcodeplz-zz Dec 7, 2016

TomAugspurger Dec 7, 2016

icanhazcodeplz-zz Dec 7, 2016

TomAugspurger commented Dec 7, 2016

icanhazcodeplz-zz commented Dec 7, 2016

jorisvandenbossche left a comment

jorisvandenbossche Dec 7, 2016

jorisvandenbossche Dec 7, 2016

jorisvandenbossche Dec 7, 2016

jorisvandenbossche Dec 7, 2016

icanhazcodeplz-zz commented Dec 8, 2016

icanhazcodeplz-zz commented Dec 8, 2016

icanhazcodeplz-zz commented Dec 9, 2016

jorisvandenbossche commented Dec 9, 2016

ENH: Add the ability to have a separate title for each subplot when plotting #14753

ENH: Add the ability to have a separate title for each subplot when plotting #14753

Conversation

icanhazcodeplz-zz commented Nov 26, 2016 • edited Loading

codecov-io commented Nov 27, 2016 • edited Loading

Current coverage is 85.26% (diff: 0.00%)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sinhrks commented Nov 27, 2016

icanhazcodeplz-zz commented Nov 28, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

icanhazcodeplz-zz commented Dec 3, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sinhrks commented Dec 6, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomAugspurger commented Dec 7, 2016

icanhazcodeplz-zz commented Dec 7, 2016

jorisvandenbossche left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

icanhazcodeplz-zz commented Dec 8, 2016

icanhazcodeplz-zz commented Dec 8, 2016

icanhazcodeplz-zz commented Dec 9, 2016

jorisvandenbossche commented Dec 9, 2016

icanhazcodeplz-zz commented Nov 26, 2016 •

edited

Loading

codecov-io commented Nov 27, 2016 •

edited

Loading