Missing _repr_latex_ method for latex/pdf conversion in jupyter notebooks #11778

bkasel · 2015-12-06T21:16:17Z

Hello, this is my very first pull request on github. I added latex/pdf conversion capabilities to the dataframe when used in a Jupyter/Ipython notebook. The method simply uses the existing to_latex method of the Dataframe class. I believe teh following Issues or PR have already attempted this, but they seem closed: #11399 and #9821

The repr_latex method looks for newly created options:
- display.latex_escape
- display.latex_longtable
which are passed as arguments to the to_latex method.

a simple test has been added to check if the conversion works. However, if the
implementation of the to_latex method changes, the test function would also have to be updated.

jreback · 2015-12-07T11:13:00Z

pandas/core/frame.py

@@ -1556,6 +1565,7 @@ def to_latex(self, buf=None, columns=None, col_space=None, colSpace=None,
            Use a longtable environment instead of tabular. Requires adding
            a \\usepackage{longtable} to your LaTeX preamble.
        escape : boolean, default True
+        escape : boolean, default True


you are duping here

jreback · 2015-12-07T11:17:35Z

pls add a whatsnew note, otherwise looks pretty good.

bkasel · 2015-12-07T11:42:52Z

I will make the changes this evening. However, I do not know exactly where to add the whatsnew note. Do I simply edit the pandas/doc/source/whatsnew/v0.18.0.txt file?

jreback · 2015-12-07T11:45:37Z

yep

jreback · 2015-12-11T01:06:11Z

doc/source/whatsnew/v0.18.0.txt

@@ -20,7 +20,9 @@ Check the :ref:`API Changes <whatsnew_0180.api>` and :ref:`deprecations <whatsne
 New features
 ~~~~~~~~~~~~

-
+- The Dataframe class got a _repr_latex_ method in order to allow for automatic conversion to latex in
+a ipython/jupyter notebook using nbconvert. Options `display.latex.escape` and `display.latex.longtable`


use double backticks around display.latex.escape (and also around DataFrame._repr_latex_)

bkasel · 2015-12-11T06:51:32Z

I made the changes. I did not add example code for the Jupyter notebook, because the changes are only visible when the notebook is converted to latex.

jreback · 2015-12-11T15:30:10Z

pandas/core/frame.py

+        Returns a LaTeX representation for a particular Dataframe.
+        Mainly for use with nbconvert (jupyter notebook conversion to pdf).
+        """
+        is_escaped = get_option("display.latex.escape")


these options should instead be in .to_latex (replace the current defaults with None, then use these)
The user can override or use the default options as the defaults.

update the .to_latex doc-string as well

jreback · 2015-12-16T14:00:41Z

@bkasel can you update according to comments

bkasel · 2015-12-16T18:22:21Z

Yes, I will do asap. I don't have a lot of free time right now. (Hopefully the WE will be better)

bkasel · 2015-12-19T10:04:05Z

OK, I think I did the adjustments the way I understood your comments. However there seem to be some conflicts. Is there a way for me to see what the conflicts are?

jorisvandenbossche · 2015-12-19T10:13:17Z

@bkasel rebasing on latest master should let you solve the conflicts:

git fetch upstream
git rebase upstream/master
git push -f

bkasel · 2015-12-19T10:17:57Z

I get an error:

git fetch upstream
fatal: 'upstream' does not appear to be a git repository
fatal: Could not read from remote repository.

jorisvandenbossche · 2015-12-19T10:18:53Z

doc/source/whatsnew/v0.18.0.txt

@@ -33,6 +33,7 @@ Other enhancements

 - Handle truncated floats in SAS xport files (:issue:`11713`)
 - ``read_excel`` now supports s3 urls of the format ``s3://bucketname/filename`` (:issue:`11447`)
+- - ``Dataframe`` has gained a ``_repr_latex_`` method in order to allow for automatic conversion to latex in a ipython/jupyter notebook using nbconvert. Options ``display.latex.escape`` and ``display.latex.longtable`` have been added to the configuration and are used automatically by the ``to_latex`` method.(:issue:`11778`)


A - too much at the beginning of the line

jorisvandenbossche · 2015-12-19T10:23:39Z

you should then replace upstream with how you called the pydata/pandas git repository ('upstream' is the canonical name for this). Do git remote -v to see a list of those.

bkasel · 2015-12-19T10:33:16Z

I didn't call it anything. I forked the repo on github and the cloned from the forked repo to my laptop.
git remote -v only shows my repo. (Sorry, complete git newbie). I managed to fetch using

git fetch https://www.github.com/pydata/pandas

but I can't rebase

jorisvandenbossche · 2015-12-19T10:36:44Z

Ah, yes, you have to add this yourself, see also our contributing guide where this is explained: http://pandas.pydata.org/pandas-docs/stable/contributing.html#forking

git remote add upstream https://github.com/pydata/pandas.git

If you need more help, we also have a dev chat channel: https://gitter.im/pydata/pandas that is sometimes easier for quick help on these things

bkasel · 2015-12-19T11:04:22Z

OK, the rebase was a bit messy, since it is the first one I have done, so I had to fix it. Seems to be OK now. Thanks for your help.

jorisvandenbossche · 2015-12-19T11:09:21Z

@bkasel rebase did indeed work! We also ask to squash the commits to have a cleaner history, see http://pandas.pydata.org/pandas-docs/stable/contributing.html#combining-commits

bkasel · 2015-12-19T14:49:24Z

I think I did the rebase and squashing succesfully.

jreback · 2015-12-19T14:52:08Z

squashing should yield 1 commit. you need to push with a -f as well.

… the Jupyter/Ipython notebook. The method simply uses the existing to_latex method of the Dataframe class. The _repr_latex_ method looks for newly created options: - display.latex_escape - display.latex_longtable which are passed as arguments to the to_latex method. a simple test has been added to check if the conversion works. However, if the implementation of the to_latex method changes, the test function would also have to be updated. - fixed style problems - renamed display.latex options - remove duplicate line - added whatsnew note Merged during rebase - fixed spelling mistake in config_init.py - the defaults for the display.latex.escape option has been changed to the defaults of the to_latex method - the to_latex method now gets these defaults from the configuration - the _repr_latex_ method now simply calls the to latex method without any options - documentation has been changed accordingly - removed one``-`` from documentation fixed bad merge during rebase - fixed test_repr_latex using new defaults

bkasel · 2015-12-19T15:36:52Z

Yes, I had some trouble getting the squashing done. Should only be a single commit now.

jreback · 2015-12-19T15:44:51Z

excellent! ping when green.

bkasel · 2015-12-19T17:06:41Z

@jreback ping

Missing _repr_latex_ method for latex/pdf conversion in jupyter notebooks

jreback · 2015-12-19T17:14:54Z

thanks!

bkasel · 2015-12-19T17:43:06Z

Nice! Thanks for the help!

AlJohri · 2018-02-24T02:12:05Z

@bkasel do you know if there's an easy way to add borders to the output latex table?

bkasel · 2018-06-19T09:41:10Z

@AlJohri I don't have an easy way to do this, since it would require \hline commands in the table which would require a modification of the Dataframe.to_latex method.

jreback reviewed Dec 7, 2015
View reviewed changes

jreback added the IO LaTeX to_latex label Dec 7, 2015

jreback added this to the 0.18.0 milestone Dec 7, 2015

jreback reviewed Dec 11, 2015
View reviewed changes

jorisvandenbossche reviewed Dec 19, 2015
View reviewed changes

bkasel force-pushed the master branch from 1761c2f to 772d7ae Compare December 19, 2015 10:58

bkasel force-pushed the master branch from 2f8e5bf to 809c468 Compare December 19, 2015 14:48

bkasel force-pushed the master branch from 17a3b9b to b4d820a Compare December 19, 2015 15:33

jreback added a commit that referenced this pull request Dec 19, 2015

Merge pull request #11778 from bkasel/master

b56b1e4

Missing _repr_latex_ method for latex/pdf conversion in jupyter notebooks

jreback merged commit b56b1e4 into pandas-dev:master Dec 19, 2015

chris-b1 mentioned this pull request Jan 30, 2016

BUG: _repr_latex is called in jupyter qtconsole #12182

Closed

Uh oh!

Missing _repr_latex_ method for latex/pdf conversion in jupyter notebooks #11778

Missing _repr_latex_ method for latex/pdf conversion in jupyter notebooks #11778

Uh oh!

Conversation

bkasel commented Dec 6, 2015

Uh oh!

jreback Dec 7, 2015

Choose a reason for hiding this comment

Uh oh!

jreback commented Dec 7, 2015

Uh oh!

bkasel commented Dec 7, 2015

Uh oh!

jreback commented Dec 7, 2015

Uh oh!

jreback Dec 11, 2015

Choose a reason for hiding this comment

Uh oh!

bkasel commented Dec 11, 2015

Uh oh!

jreback Dec 11, 2015

Choose a reason for hiding this comment

Uh oh!

jreback commented Dec 16, 2015

Uh oh!

bkasel commented Dec 16, 2015

Uh oh!

bkasel commented Dec 19, 2015

Uh oh!

jorisvandenbossche commented Dec 19, 2015

Uh oh!

bkasel commented Dec 19, 2015

Uh oh!

jorisvandenbossche Dec 19, 2015

Choose a reason for hiding this comment

Uh oh!

jorisvandenbossche commented Dec 19, 2015

Uh oh!

bkasel commented Dec 19, 2015

Uh oh!

jorisvandenbossche commented Dec 19, 2015

Uh oh!

bkasel commented Dec 19, 2015

Uh oh!

jorisvandenbossche commented Dec 19, 2015

Uh oh!

bkasel commented Dec 19, 2015

Uh oh!

jreback commented Dec 19, 2015

Uh oh!

bkasel commented Dec 19, 2015

Uh oh!

jreback commented Dec 19, 2015

Uh oh!

bkasel commented Dec 19, 2015

Uh oh!

jreback commented Dec 19, 2015

Uh oh!

bkasel commented Dec 19, 2015

Uh oh!

AlJohri commented Feb 24, 2018

Uh oh!

bkasel commented Jun 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

bkasel commented Jun 19, 2018 •

edited

Loading