Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add plot_layout basic functionality #99

Merged
merged 2 commits into from
May 14, 2024
Merged

add plot_layout basic functionality #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ed66ef
add plot_layout basic functionality: nrow, ncol, width, height
cnrrobertson Apr 29, 2024
2bb9d06
cleanup patchwork tests kwargs
cnrrobertson May 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/TidierPlots.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ export draw_ggplot, ggplot, ggsave
export TidierPlots_set
export @aes, @es, aes
export geom_template
export plot_layout

# geoms

Expand Down
93 changes: 92 additions & 1 deletion src/patchwork.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,101 @@ function combine_plots(catfunc::Function, args::Union{GGPlot,GGPlotGrid}...)
end

# + -> side by side
Base.:+(args::Union{GGPlot, GGPlotGrid}...) = combine_plots(hcat, args...)
function Base.:+(args::Union{GGPlot, GGPlotGrid, GGPlotGridSpec}...)
if any(isa.(args, GGPlotGridSpec))
return add_gridspec(args...)
else
return combine_plots(hcat, args...)
end
end

# | -> side by side
Base.:|(args::Union{GGPlot, GGPlotGrid}...) = combine_plots(hcat, args...)

# / -> p1 above p2
Base.:/(args::Union{GGPlot, GGPlotGrid}...) = combine_plots(vcat, args...)

# Define plot layout
function plot_layout(;ncol=0, nrow=0, byrow=false, widths=Int[], heights=Int[])
return GGPlotGridSpec(ncol, nrow, byrow, widths, heights)
end

function add_gridspec(args::Union{GGPlot, GGPlotGrid, GGPlotGridSpec}...)
# Separate plots from gridspec
plots = Union{GGPlot,GGPlotGrid}[]
gridspec = nothing
for arg in args
if arg isa GGPlotGridSpec
# Merge gridspecs
if isnothing(gridspec)
gridspec = arg
else
for k in fieldnames(GGPlotGridSpec)
setfield!(gridspec, getfield(arg, k))
end
end
else
push!(plots, arg)
end
end

# Arrange plots
nplots = length(plots)
ncol = gridspec.ncol
nrow = gridspec.nrow
if (nrow == 0) & (ncol == 0)
# Default: more cols than rows
nrow = Int(round(sqrt(nplots)))
ncol = Int(ceil(sqrt(nplots)))
elseif (nrow == 0)
# As many rows as needed
nrow = Int(ceil(nplots / ncol))
elseif (ncol == 0)
# As many cols as needed
ncol = Int(ceil(nplots / nrow))
end
layout = Pair{Tuple{Int64,Int64}, Union{Makie.BlockSpec, Makie.GridLayoutSpec}}[]
plot_i = 1
if gridspec.byrow
for j in 1:ncol, i in 1:nrow
if plot_i <= nplots
tmp_plot = plots[plot_i]
axis = tmp_plot isa GGPlot ? SpecApi.Axis(tmp_plot) : tmp_plot.grid
push!(layout, (i, j) => axis)
plot_i += 1
end
end
else
for i in 1:nrow, j in 1:ncol
if plot_i <= nplots
tmp_plot = plots[plot_i]
axis = tmp_plot isa GGPlot ? SpecApi.Axis(tmp_plot) : tmp_plot.grid
push!(layout, (i, j) => axis)
plot_i += 1
end
end
end

# Adjust sizes
widths = isempty(gridspec.widths) ? ones(ncol) : gridspec.widths
heights = isempty(gridspec.heights) ? ones(nrow) : gridspec.heights
total_width = sum(widths)
total_height = sum(heights)
all_plots = GGPlot[]
for p in plots
if isa(p, GGPlot)
push!(all_plots, p)
else
push!(all_plots, p.plots...)
end
end
return GGPlotGrid(
all_plots,
SpecApi.GridLayout(
layout,
colsizes = [Relative(w/total_width) for w in widths],
rowsizes = [Relative(h/total_height) for h in heights]
)
)
end

10 changes: 9 additions & 1 deletion src/structs.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,12 @@ end
struct GGPlotGrid
plots::Vector{GGPlot}
grid::Any
end
end

struct GGPlotGridSpec
ncol::Int
nrow::Int
byrow::Bool
widths::Vector{Int}
heights::Vector{Int}
end
159 changes: 158 additions & 1 deletion test/test_patchwork.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,161 @@ end

@test plot_images_equal((t | t) / t, m21)
end
end

@testset "plot layout organization" begin
t = ggplot(penguins) +
geom_point(@aes(x = bill_length_mm, y = bill_depth_mm))
t2 = ggplot(penguins) +
geom_point(@aes(x = bill_depth_mm, y = bill_length_mm))
test_ax = Makie.SpecApi.Axis(
plots = [Makie.PlotSpec(
:Scatter, penguins.bill_length_mm, penguins.bill_depth_mm
)]
)
test_ax2 = Makie.SpecApi.Axis(
plots = [Makie.PlotSpec(
:Scatter, penguins.bill_depth_mm, penguins.bill_length_mm
)]
)
# 2x2 grid
m22 = Makie.plot(
Makie.SpecApi.GridLayout([
test_ax test_ax2;
test_ax test_ax2
],
)
)
@test plot_images_equal(t + t2 + t + t2 + plot_layout(), m22)
@test plot_images_equal(t + t2 + t + t2 + plot_layout(ncol=2,nrow=2), m22)
@test plot_images_equal(t + t + t2 + t2 + plot_layout(ncol=2,nrow=2,byrow=true), m22)
@test plot_images_equal(t + t2 + t + t2 + plot_layout(ncol=2,nrow=0), m22)

# 2x2 grid (missing bottom right)
m21 = Makie.plot(
Makie.SpecApi.GridLayout([
(1,1) => test_ax,
(1,2) => test_ax2,
(2,1) => test_ax
]
)
)
@test plot_images_equal(t + t2 + t + plot_layout(nrow=2,ncol=2), m21)
@test plot_images_equal(t + t2 + t + plot_layout(nrow=2), m21)
@test plot_images_equal(t + t2 + t + plot_layout(), m21)

# 1x3 grid
m13 = Makie.plot(
Makie.SpecApi.GridLayout([
(1,1) => test_ax,
(1,2) => test_ax,
(1,3) => test_ax
]
)
)
@test plot_images_equal(t + t + t + plot_layout(nrow=1), m13)
end

@testset "plot layout sizes" begin
t = ggplot(penguins) +
geom_point(@aes(x = bill_length_mm, y = bill_depth_mm))
t2 = ggplot(penguins) +
geom_point(@aes(x = bill_depth_mm, y = bill_length_mm))
test_ax = Makie.SpecApi.Axis(
plots = [Makie.PlotSpec(
:Scatter, penguins.bill_length_mm, penguins.bill_depth_mm
)]
)
test_ax2 = Makie.SpecApi.Axis(
plots = [Makie.PlotSpec(
:Scatter, penguins.bill_depth_mm, penguins.bill_length_mm
)]
)
# 2x2 grid (variable columns widths)
m22c = Makie.plot(
Makie.SpecApi.GridLayout([
test_ax test_ax2;
test_ax test_ax2
],
colsizes = [Relative(1/3), Relative(2/3)]
)
)
@test plot_images_equal(t + t2 + t + t2 + plot_layout(widths=[1,2]), m22c)

# 2x2 grid (missing bottom right)
m21 = Makie.plot(
Makie.SpecApi.GridLayout([
(1,1) => test_ax,
(1,2) => test_ax2,
(2,1) => test_ax
],
colsizes = [Relative(1/3), Relative(2/3)]
)
)
@test plot_images_equal(t + t2 + t + plot_layout(widths=[1,2]), m21)

# 2x2 grid (variable row heights)
m22r = Makie.plot(
Makie.SpecApi.GridLayout([
test_ax test_ax2;
test_ax test_ax2
],
rowsizes = [Relative(1/3), Relative(2/3)]
)
)
@test plot_images_equal(t + t2 + t + t2 + plot_layout(heights=[1,2]), m22r)

# 1x3 grid
m13 = Makie.plot(
Makie.SpecApi.GridLayout([
(1,1) => test_ax,
(1,2) => test_ax,
(1,3) => test_ax
],
colsizes = [Relative(1/6), Relative(2/6), Relative(3/6)]
)
)
@test plot_images_equal(t + t + t + plot_layout(nrow=1, widths=[1,2,3]), m13)

# 2x3 grid variable height and width
m23 = Makie.plot(
Makie.SpecApi.GridLayout([
(1,1) => test_ax,
(1,2) => test_ax,
(1,3) => test_ax,
(2,1) => test_ax2,
(2,2) => test_ax2,
(2,3) => test_ax2
],
colsizes = [Relative(1/6), Relative(2/6), Relative(3/6)],
rowsizes = [Relative(1/5), Relative(4/5)]
)
)
@test plot_images_equal(t + t + t + t2 + t2 + t2 + plot_layout(nrow=2, widths=[1,2,3], heights=[1,4]), m23)
end

@testset "plot layout grids" begin
t = ggplot(penguins) +
geom_point(@aes(x = bill_length_mm, y = bill_depth_mm))
t2 = ggplot(penguins) +
geom_point(@aes(x = bill_depth_mm, y = bill_length_mm))
test_ax = Makie.SpecApi.Axis(
plots = [Makie.PlotSpec(
:Scatter, penguins.bill_length_mm, penguins.bill_depth_mm
)]
)
test_ax2 = Makie.SpecApi.Axis(
plots = [Makie.PlotSpec(
:Scatter, penguins.bill_depth_mm, penguins.bill_length_mm
)]
)
m22c = Makie.plot(
Makie.SpecApi.GridLayout([
Makie.SpecApi.GridLayout([test_ax test_ax]) test_ax2;
test_ax test_ax2
],
colsizes = [Relative(1/3), Relative(2/3)]
)
)
@test plot_images_equal((t | t) + t2 + t + t2 + plot_layout(widths=[1,2]), m22c)
end
end
Loading