allow changing latexify style (#101)

* RootedTrees.set_latexify_style

* update docs

* format

Author: ranocha

Project.toml

@@ -1,7 +1,7 @@
 name = "RootedTrees"
 uuid = "47965b36-3f3e-11e9-0dcf-4570dfd42a8c"
 authors = ["Hendrik Ranocha <mail@ranocha.de> and contributors"]
-version = "2.16.0"
+version = "2.17.0"
 
 [deps]
 Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"

docs/src/tutorials/basics.md

@@ -42,6 +42,25 @@ This results in the following LaTeX output:
 
 ![latex-trees](https://user-images.githubusercontent.com/12693098/196148917-6e3cf000-5bc3-4798-8a82-d6e939bb6a8f.png)
 
+To get a human-readable output, you can use
+[`RootedTrees.set_latexify_style`](@ref). This can be particularly helpful when
+working in Jupyter notebooks, e.g., by passing the output of `latexify` to
+`IPython.display.Latex`.
+
+```@example basics
+RootedTrees.set_latexify_style("butcher")
+
+for t in RootedTreeIterator(4)
+    println(RootedTrees.latexify(t))
+end
+
+RootedTrees.set_latexify_style("forest")
+
+for t in RootedTreeIterator(4)
+    println(RootedTrees.latexify(t))
+end
+```
+
 If you want to visualize individual trees, you can also use our plot recipes
 for [Plots.jl](https://github.com/JuliaPlots/Plots.jl).
 
@@ -131,6 +150,24 @@ for t in BicoloredRootedTreeIterator(3)
 end
 ```
 
+The style can be adapted as well via [`RootedTrees.set_latexify_style`](@ref).
+
+```@example basics
+RootedTrees.set_latexify_style("butcher")
+
+for t in BicoloredRootedTreeIterator(3)
+    println(RootedTrees.latexify(t))
+end
+
+RootedTrees.set_latexify_style("forest")
+
+for t in BicoloredRootedTreeIterator(3)
+    println(RootedTrees.latexify(t))
+end
+```
+
+Plotting is of course also implemented for colored rooted trees.
+
 ```@example basics
 using Plots
 t = rootedtree([1, 2, 3, 3, 2, 2], Bool[0, 0, 1, 0, 1, 0])

src/RootedTrees.jl

@@ -183,7 +183,7 @@ end
 #RootedTree{T<:Integer}(sequence::Vector{T}) = RootedTree{T}(sequence, false)
 
 function Base.show(io::IO, t::RootedTree{T}) where {T}
-    printing_style = @load_preference("printing_style")
+    printing_style = @load_preference("printing_style", "sequence")
     if printing_style == "butcher"
         print(io, butcher_representation(t))
     else

src/latexify.jl

@@ -34,6 +34,9 @@ the following LaTeX code in the preamble.
 
 ```
 
+To change the style of `latexify` to a human-readable Butcher-representation,
+you can use [`RootedTrees.set_latexify_style`](@ref).
+
 # Examples
 
 ```jldoctest
@@ -48,32 +51,61 @@ function latexify(t::RootedTree)
     if isempty(t)
         return "\\varnothing"
     end
-    list_representation = butcher_representation(t, false)
-    s = "\\rootedtree" * replace(list_representation, "τ" => "[]")
-    return replace(s, "[" => "[.")
+    latexify_style = @load_preference("latexify_style", "forest")
+    if latexify_style == "butcher"
+        return butcher_representation(t)
+    else # forest
+        list_representation = butcher_representation(t, false)
+        s = "\\rootedtree" * replace(list_representation, "τ" => "[]")
+        return replace(s, "[" => "[.")
+    end
 end
 
 function latexify(t::BicoloredRootedTree)
     if isempty(t)
         return "\\varnothing"
     end
-    list_representation = butcher_representation(rootedtree(t.level_sequence), false)
-    s = "\\rootedtree" * replace(list_representation, "τ" => "[]")
-    # The first entry of `substrings` is "\\rootedtree".
-    substrings = split(s, "[")
-    strings = String[]
-    for (color, substring) in zip(t.color_sequence, substrings)
-        if color == false
-            push!(strings, substring * "[.")
-        elseif color == true
-            push!(strings, substring * "[o")
+    latexify_style = @load_preference("latexify_style", "forest")
+    if latexify_style == "butcher"
+        return butcher_representation(t)
+    else # forest
+        list_representation = butcher_representation(rootedtree(t.level_sequence), false)
+        s = "\\rootedtree" * replace(list_representation, "τ" => "[]")
+        # The first entry of `substrings` is "\\rootedtree".
+        substrings = split(s, "[")
+        strings = String[]
+        for (color, substring) in zip(t.color_sequence, substrings)
+            if color == false
+                push!(strings, substring * "[.")
+            elseif color == true
+                push!(strings, substring * "[o")
+            end
         end
+        # We still need to add the last part dropped by `zip`.
+        push!(strings, last(substrings))
+        return join(strings)
     end
-    # We still need to add the last part dropped by `zip`.
-    push!(strings, last(substrings))
-    return join(strings)
 end
 
 Latexify.@latexrecipe function _(t::Union{RootedTree, BicoloredRootedTree})
     return Latexify.LaTeXString(RootedTrees.latexify(t))
 end
+
+"""
+    RootedTrees.set_latexify_style(style::String)
+
+Set the style of rooted trees when using [`latexify`](@ref). Possible options are
+
+- "butcher": print the [`butcher_representation`](@ref) of rooted trees
+- "forest": use the LaTeX macro `\\rootedtree` described in the docstring of
+  [`latexify`](@ref)
+
+This system is based on [Preferences.jl](https://github.com/JuliaPackaging/Preferences.jl).
+"""
+function set_latexify_style(style::String)
+    if !(style in ("butcher", "forest"))
+        throw(ArgumentError("Invalid printing style: \"$(style)\""))
+    end
+
+    @set_preferences!("latexify_style"=>style)
+end