Output to LaTeX added (useful for IJulia notebook export to PDF) #845

maximerischard · 2015-07-14T11:34:21Z

At the moment DataFrames look great in IJulia (thanks to #433) until they are exported to PDF. This commit adds an additional writemime method for the text/latex mimetype.

maximerischard · 2015-07-14T11:37:38Z

For example

using DataFrames
using LaTeXStrings
df = DataFrame(A = 1:4, B = ["M", "F", "F", L"\alpha"])
print(stringmime(MIME("text/latex"), df))

outputs

\begin{tabular}{r|cc}
    &A&B\\ 
    \hline 
    1 &1&M\\ 
    2 &2&F\\ 
    3 &3&F\\ 
    4 &4&$\alpha$\\ 
\end{tabular}

johnmyleswhite · 2015-07-15T14:39:17Z

This is awesome. One concern: I think you don't do any string escaping, so what happens if the rows contain data with ampersands in them?

nalimilan · 2016-09-27T08:38:15Z

Sorry for missing this. Would you mind updating this to the new show system in Julia 0.5? Then I promise I'll merge.

ararslan · 2016-09-27T17:19:58Z

src/abstractdataframe/io.jl

+#
+##############################################################################
+
+function latex_char_escape(char::SubString)


It's my understanding that SubString will eventually be merged into String. Also, why not use Char?

Agreed, should either be Char or AbstractString.

I still think this should be Char or AbstractString. Either is fine, though the function and argument name suggest to me that Char would make the most sense.

maximerischard · 2016-09-28T14:03:17Z

Hmm, I tried rebasing the PR, not sure what happened here. But I've made the few changes that were requested. Here's a new example:

using DataFrames
using LaTeXStrings
df = DataFrame(A = 1:4, 
               B = ["\$10.0", "M&F", "A~B", "\\alpha"], 
               C = [L"\alpha", L"\beta", L"\gamma", L"\sum_{i=1}^n \delta_i"],
               D = [π, 2π, Nullable(), 3π]
               )
print(reprmime(MIME("text/latex"), df))

outputs

\begin{tabular}{r|cccc}
    & A & B & C & D\\ 
    \hline 
    1 & 1 & \$10.0 & $\alpha$ & 3.141592653589793 \\ 
    2 & 2 & M\&F & $\beta$ & 6.283185307179586 \\ 
    3 & 3 & A\textasciitilde{}B & $\gamma$ &  \\ 
    4 & 4 & \textbackslash{}alpha & $\sum_{i=1}^n \delta_i$ & 9.42477796076938 \\ 
\end{tabular}

Let me know what needs to be done to make this merge-able.

nalimilan · 2016-09-28T14:30:29Z

Hmm, I'm not sure what you did, but that's definitely not right. Try a git rebase origin/master.

maximerischard · 2016-09-28T15:18:49Z

OK, I just spent a bit of time in git hell, and I think this might be alright now.

nalimilan · 2016-09-28T16:26:04Z

src/abstractdataframe/io.jl

+end
+
+function Base.show(io::IO,
+                        ::MIME"text/latex",


Alignment issue here.

nalimilan · 2016-09-28T16:28:11Z

src/abstractdataframe/io.jl

+    nrows = size(df, 1)
+    ncols = size(df, 2)
+    cnames = _names(df)
+    alignment = join(["c" for _ in 1:ncols])


You can write this as repeat("c", ncols) or "c"^ncols.

nalimilan · 2016-09-28T16:28:58Z

src/abstractdataframe/io.jl

+            if !isnull(cell)
+                content = get(cell)
+                if mimewritable(MIME("text/latex"), content)
+                    Base.show(io, MIME("text/latex"), content)


No need for Base. here and below.

nalimilan · 2016-09-28T16:29:49Z

Cool, thanks! Could you address the comments and add some tests?

ararslan · 2016-09-28T19:57:17Z

src/abstractdataframe/io.jl

+
+function Base.show(io::IO, ::MIME"text/latex", df::AbstractDataFrame)
+    nrows = size(df, 1)
+    ncols = size(df, 2)


Could be written more succinctly as nrows, ncols = size(df). Doesn't matter too much, just thought I'd point it out.

maximerischard · 2016-09-28T19:57:41Z

I've added a test using my example. It's not the most elegant test (suggestions welcome!), and it adds a dependency to LaTeXStrings for tests, but I think it's important to have objects in the test dataframe for which a show function to LaTeX already exists.

ararslan · 2016-09-28T19:58:11Z

test/io.jl

@@ -1,6 +1,7 @@
 module TestIO
    using Base.Test
    using DataFrames, Compat
+    using LaTeXStrings


If this introduces a test dependency on an external package, the package will have to be included in test/REQUIRE.

nalimilan · 2016-09-29T08:04:25Z

test/io.jl

+                   C = [L"\alpha", L"\beta", L"\gamma", L"\sum_{i=1}^n \delta_i"],
+                   D = [1.0, 2.0, Nullable(), 3.0]
+                   )
+    @test isequal(reprmime(MIME("text/latex"), df), "\\begin{tabular}{r|cccc}\n\t& A & B & C & D\\\\ \n\t\\hline \n\t1 & 1 & \\\$10.0 & \$\\alpha\$ & 1.0 \\\\ \n\t2 & 2 & M\\&F & \$\\beta\$ & 2.0 \\\\ \n\t3 & 3 & A\\textasciitilde{}B & \$\\gamma\$ &  \\\\ \n\t4 & 4 & \\textbackslash{}alpha & \$\\sum_{i=1}^n \\delta_i\$ & 3.0 \\\\ \n\\end{tabular}\n")


I think using a multiline string block (""") you should be able to replace the \n by actual line breaks to make it more readable.

nalimilan · 2016-09-29T16:03:47Z

test/io.jl

@@ -498,6 +498,13 @@ module TestIO
                   C = [L"\alpha", L"\beta", L"\gamma", L"\sum_{i=1}^n \delta_i"],
                   D = [1.0, 2.0, Nullable(), 3.0]
                   )
-    @test isequal(reprmime(MIME("text/latex"), df), "\\begin{tabular}{r|cccc}\n\t& A & B & C & D\\\\ \n\t\\hline \n\t1 & 1 & \\\$10.0 & \$\\alpha\$ & 1.0 \\\\ \n\t2 & 2 & M\\&F & \$\\beta\$ & 2.0 \\\\ \n\t3 & 3 & A\\textasciitilde{}B & \$\\gamma\$ &  \\\\ \n\t4 & 4 & \\textbackslash{}alpha & \$\\sum_{i=1}^n \\delta_i\$ & 3.0 \\\\ \n\\end{tabular}\n")
+    @test isequal(reprmime(MIME("text/latex"), df),
+        """\\begin{tabular}{r|cccc}


Please use spaces instead of tabs. Also, why not align the last line with the rest of the contents?

Because the multiline string has to match the output of reprmime.

But triple-quoted strings are also automatically deindented, so you can still align them with the """ block: http://docs.julialang.org/en/latest/manual/strings/#triple-quoted-string-literals

That's really cool! I didn't know that.

maximerischard · 2016-10-02T03:26:29Z

What happens next?

ararslan · 2016-10-02T04:38:44Z

src/abstractdataframe/io.jl

+#
+##############################################################################
+
+function latex_char_escape(char::SubString)


I still think this should be Char or AbstractString. Either is fine, though the function and argument name suggest to me that Char would make the most sense.

nalimilan · 2016-10-02T11:06:44Z

What happens next?

We generally keep PRs open few a few days to allow people to comment. And indeed @ararslan found an issue I had missed the second time.

nalimilan · 2016-10-03T13:51:03Z

Thanks!

nalimilan · 2016-10-03T18:38:20Z

src/abstractdataframe/io.jl

+        for col in 1:ncols
+            write(io, " & ")
+            cell = df[row,col]
+            if !isnull(cell)


Sorry, I hadn't noticed this. This should print #NULL instead of nothing for null values, just like at the REPL and in HTML. Could you apply the strategy I described at #1084 in a new PR?

ararslan reviewed Sep 27, 2016

View reviewed changes

maximerischard and others added 5 commits September 28, 2016 11:11

Output to LaTeX added (useful for IJulia notebook export to PDF)

c0e0ac1

add escaping of strings for LaTeX output

1b24873

avoid providing a latex writemime method for every type

48b175b

latex output: escape headers

25f9b00

writemime -> show and deal with nullable cells

1653762

maximerischard force-pushed the pull-request/246c8b4c branch from 15ddd85 to 1653762 Compare September 28, 2016 15:17

nalimilan reviewed Sep 28, 2016

View reviewed changes

src/abstractdataframe/io.jl

end

function Base.show(io::IO,

::MIME"text/latex",

Copy link

Member

nalimilan Sep 28, 2016

Choose a reason for hiding this comment

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

Alignment issue here.

nalimilan reviewed Sep 28, 2016

View reviewed changes

maximerischard added 2 commits September 28, 2016 15:54

improve style of LaTeX output

446201a

add tests for LaTeX output

0dd1e75

ararslan reviewed Sep 28, 2016

View reviewed changes

add LaTeXStrings to test/REQUIRE

e6223aa

nalimilan reviewed Sep 29, 2016

View reviewed changes

make LaTeX test more readable

2473d4b

nalimilan reviewed Sep 29, 2016

View reviewed changes

better indentation for LaTeX test

186315d

nalimilan approved these changes Sep 29, 2016

View reviewed changes

ararslan requested changes Oct 2, 2016

View reviewed changes

latex_char_escape takes AbstractString

c4512f4

ararslan approved these changes Oct 3, 2016

View reviewed changes

nalimilan merged commit 1658c35 into JuliaData:master Oct 3, 2016

nalimilan reviewed Oct 3, 2016

View reviewed changes

nalimilan pushed a commit that referenced this pull request Jul 8, 2017

Add output to LaTeX (useful for IJulia notebook export to PDF) (#845)

437b7cc

nalimilan pushed a commit that referenced this pull request Jul 8, 2017

Add output to LaTeX (useful for IJulia notebook export to PDF) (#845)

2e97b85

rofinn pushed a commit that referenced this pull request Aug 17, 2017

Add output to LaTeX (useful for IJulia notebook export to PDF) (#845)

d042f7e

nalimilan pushed a commit that referenced this pull request Aug 25, 2017

Add output to LaTeX (useful for IJulia notebook export to PDF) (#845)

1310b23

quinnj pushed a commit that referenced this pull request Sep 2, 2017

Add output to LaTeX (useful for IJulia notebook export to PDF) (#845)

84993d1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Output to LaTeX added (useful for IJulia notebook export to PDF) #845

Output to LaTeX added (useful for IJulia notebook export to PDF) #845

maximerischard commented Jul 14, 2015

maximerischard commented Jul 14, 2015

johnmyleswhite commented Jul 15, 2015

nalimilan commented Sep 27, 2016

ararslan Sep 27, 2016

nalimilan Sep 28, 2016

ararslan Oct 2, 2016

maximerischard commented Sep 28, 2016

nalimilan commented Sep 28, 2016

maximerischard commented Sep 28, 2016

nalimilan Sep 28, 2016

nalimilan Sep 28, 2016

nalimilan Sep 28, 2016

nalimilan commented Sep 28, 2016

ararslan Sep 28, 2016

maximerischard commented Sep 28, 2016

ararslan Sep 28, 2016

nalimilan Sep 29, 2016

nalimilan Sep 29, 2016

maximerischard Sep 29, 2016

nalimilan Sep 29, 2016

maximerischard Sep 29, 2016

maximerischard commented Oct 2, 2016

ararslan Oct 2, 2016

nalimilan commented Oct 2, 2016

nalimilan commented Oct 3, 2016

nalimilan Oct 3, 2016

Output to LaTeX added (useful for IJulia notebook export to PDF) #845

Output to LaTeX added (useful for IJulia notebook export to PDF) #845

Conversation

maximerischard commented Jul 14, 2015

maximerischard commented Jul 14, 2015

johnmyleswhite commented Jul 15, 2015

nalimilan commented Sep 27, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maximerischard commented Sep 28, 2016

nalimilan commented Sep 28, 2016

maximerischard commented Sep 28, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nalimilan commented Sep 28, 2016

Choose a reason for hiding this comment

maximerischard commented Sep 28, 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

maximerischard commented Oct 2, 2016

Choose a reason for hiding this comment

nalimilan commented Oct 2, 2016

nalimilan commented Oct 3, 2016

Choose a reason for hiding this comment