Feat implement all basic recipes

[BenjaminDoran]

Hey @cvgilv

I've finally had some time to work on this repo. Sorry for the delay.

I took your PR #15 and updated the recipies to use Makie v0.24 and fixed the issues with plotting on a polar axis. I did heavily modify the api. So rather than directly providing the tree to treelabels, treecladelabel, or treearea. The user provide tp.nodepoints the dictionary of node => Point2f pairs as calculated by treeplot. This reduces the need to recalculate the coordinates and stops the user needing to remember to match the arguments between plotting functions. It also means A lot of the redundant options were removed.

Example usage is below

using CairoMakie, BasicTreePlots

tree = ((:a, :b), (:c, (:d, :e)))
nodelabels = [:a => "Alpha", :b => "Bravo", (:a, :b) => "Parent", (:a, :b) => "Parent", :d => "Delta"]
bcolor = rand(9);

fig = Figure(size = (1000, 500))

ax1 = Axis(fig[1, 1], xautolimitmargin = (0.05, 0.1))
hidedecorations!(ax1)
# hidespines!(ax)
tp = treeplot!(tree, branchwidth = 3, colormap = :vik, visible = true, branchstyle=:straight)
treelabels!(tp.nodepoints; depth = tp.maxtreedepth[] + 0.1)
scatter!(tp.orderedpoints, markersize = 30, color = rand(9))
treecladelabel!(tp.nodepoints, lineoffset = 0.3, color = (:green))
treearea!(tp.nodepoints; 
	nodes = [tree, tree[1]],
	strokecolor=(:black, 0.2)
)
treearea!(tp.nodepoints; 
	nodes = [ tree[2], tree[2][2]],
	strokecolor=(:black, 0.2)
)


ax2 = PolarAxis(fig[1, 2], rautolimitmargin = (0.0, 0.2))
hidedecorations!(ax2)
hidespines!(ax2)

tp = treeplot!(tree, branchwidth = 3, colormap = :vik, visible=true)
treelabels!(tp.nodepoints; nodelabels, labeloffset=(0.0, 0.2))
treecladelabel!(tp.nodepoints;
	nodelabels = [(:a, :b) => "clade 1", ((:d, :e), "clade 2")],
	lineoffset = (1.7, 1.5),
)
treecladelabel!(tp.nodepoints;
	lineoffset = 2.5,
	color = :green,
	labeloffset = (-2.0, -2.0),
)
ta = treearea!(tp.nodepoints; 
	nodes=[(:a, :b), (:c, (:d, :e)), (:d, :e)], 
	resolution=25, 
	color=[:lightgreen, (:lightgrey, 0.25), (:grey, 0.5)],
	strokecolor=:transparent,
)
fig

Also note that tp.orderedpoints is also accessible from the treeplot plot object. This allows for directly using Makie's scatter recipe with all options as the tp.orderedpoints are the nodes of the tree in PreOrderDFS order. As such I am removing the treescatter recipe for now. Though, I could be convinced to bring it back in a separate pull request if there is a use case that the standard scatter recipe doesn't cover for trees.

I'll likely merge this pull request into the main branch in the next week or so. But I would like to improve the documentation a bit before bumping the version number and fully releasing these changes.

If you have some time, do please checkout the branch and let me know of any issues you find. And thanks again for your help with initiating these extra recipes.

[cvigilv]

This is great! I was thinking if maybe abstracting away some aspects would benefit the code. For example, one could dispatch some of this plotting functions with the treeplot struct or with the expected data type (e.g. Vector of Strings).

I like much more:

tree = <tree generation function>
tp = treeplot!(tree)
treelabels!(tp; depth = d -> d + 0.1)

than the current state:

tree = <tree generation function>
tp = treeplot!(tree)
treelabels!(tp.nodepoints; depth = tp.maxtreedepth[] + 0.1)

I think is cleaner and more "julian".

I would leave treescatter, since we can do a dispatch specifically for the treeplot structure. Synonyms are not terrible when implementing a DSL (which this package basically is), since one can make the code much more readable when using the domain's language.

LMKWYT

[BenjaminDoran]

Agreed, I would like that style of syntax. Annoyingly because these are recipes, the dispatches are not simple. Just passing the plot object to the next recipe leads to some argument errors before even getting to the function body. So It needs some thinking about how to actually pass a plot object to a new recipe.

tree = ((:a, :b), (:c, (:d, :e)))
fig, ax, tp = treeplot(tree)
treelabels!(tp)
fig 

ArgumentError: Failed to construct plot: No plot arguments given.

Stacktrace:
 [1] (Plot{BasicTreePlots.treelabels})(user_args::Tuple{}, user_attributes::Dict{Symbol, Any})
   @ Makie ~/.julia/packages/Makie/TOy8O/src/compute-plots.jl:717
 [2] _create_plot!(::Function, ::Dict{Symbol, Any}, ::Plot{BasicTreePlots.treeplot, Tuple{Tuple{Tuple{Symbol, Symbol}, Tuple{Symbol, Tuple{Symbol, Symbol}}}}})
   @ Makie ~/.julia/packages/Makie/TOy8O/src/figureplotting.jl:416
 [3] treelabels!(args::Plot{BasicTreePlots.treeplot, Tuple{Tuple{Tuple{Symbol, Symbol}, Tuple{Symbol, Tuple{Symbol, Symbol}}}}}; kw::@Kwargs{})
   @ BasicTreePlotsMakieExt ~/.julia/packages/Makie/TOy8O/src/recipes.jl:534
 [4] treelabels!(args::Plot{BasicTreePlots.treeplot, Tuple{Tuple{Tuple{Symbol, Symbol}, Tuple{Symbol, Tuple{Symbol, Symbol}}}}})
   @ BasicTreePlotsMakieExt ~/.julia/packages/Makie/TOy8O/src/recipes.jl:532
 [5] top-level scope
   @ ~/projects/BasicTreePlots.jl/test/jl_notebook_cell_df34fa98e69747e1a8f8a730347b8e2f_X26sZmlsZQ==.jl:7

I'll take another look. I went to this syntax because it was working and preventing recomputation

But, if you figure out a way to directly pass the plot object with the v0.24 syntax, please let me know.

I don't think that syntax should hold up these recipes as a whole though.

[BenjaminDoran]

This should close issues #9 and #10