Axes at interior panels #4064

[teunbrand]

This PR aims to implement drawing axes at interior facets proposed in #4064. It implements this for facet_wrap() as well as for facet_grid(). While the changes for facet_wrap() are quite minimal, for facet_grid() some additional code was borrowed from facet_wrap() to draw additional axes.

A few discussion points:

• With regards to the main challenge (the name of the argument), I went with draw.axes because it felt somewhat more intuitive than just axes to me. I'm not particularly attached to the name though.
• I also think the unit tests might still be improved, they now require drawing four plots which doesn't make the tests particularly lightweight.
• Lastly, Annotate all facets with axis ticks and labels for fixed scales #4064 (comment) mentions an option for omitting the labels at interior axes. I could add this, but wanted to ask if the maintainers approve of this first.

Two small demonstrations:

library(ggplot2)

df <- data.frame(
  x = 1, y = 1, facet = LETTERS[1:4]
)

ggplot(df, aes(x, y)) +
  geom_point() +
  facet_wrap(vars(facet), draw.axes = "all")

df <- data.frame(
  x = 1:4, y = 1:4, 
  fx = c("A", "A", "B", "B"),
  fy = c("c", "d", "c", "d")
)

ggplot(df, aes(x, y)) +
  geom_point() +
  facet_grid(vars(fy), vars(fx), draw.axes = "all")

^{Created on 2021-05-05 by the reprex package (v1.0.0)}

[smouksassi]

When I need this functionality I rely on:
https://cran.r-project.org/web/packages/lemon/vignettes/facet-rep-labels.html
It offers different ways to specify how axes are repeated

[smouksassi]

Agree having this in ggplot2 will make it more mainstream I use ggh4x a lot especially the facet_nested ! Thank you !

[thomasp85]

@clauswilke any thoughts on this - I'm in two minds

[clauswilke]

I like this feature. My workaround, which I use all the time, is to set scales to free and then impose scale limits. This has the same effect visually but is a bit confusing, as it requires setting two contradictory options. I'd also say that being able to omit labels for interior plots would be useful.

I haven't reviewed the code, though.

[hadley]

The current interface seems like a reasonable compromise to me; it meaningfully improves the display options available, without getting bogged down into too many details. However, I do think axes fits better with the current argument names than draw.axes.

@teunbrand do you mind changing to axes and then merging/rebasing against main?

@clauswilke do you want to review this? or should I?

[teunbrand]

Thanks Hadley! I'll take a look in a few days time once I've got some to spare myself.

[teunbrand]

option for omitting the labels at interior axes

Revisiting this topic now a while later, I don't think there currently exists a clean path towards omitting labels. We can edit the axis grob in the draw_panels() method, but it feels a bit messy. While I think it is useful to be able to omit labels, the messy approach might be more difficult to maintain in the future, and the faceting code is already quite complicated.

What I think is a neater solution would be to create an argument in the render_axes() function that propagates all the way down to ggplot2:::guide_gengrob.axis(), that controls the drawing of the label parts. I could give this a go, but it might be a good idea to postpone this and consider implementing #3329 first.

[teunbrand]

Yeah it looks like it should if no interior axes are drawn or the interior axes are drawn with labels. The issue is that the space reserved for axes is calculated as the maximum size for all the axes in a particular row or column. We could try to calculate the size of only the relevant axes that are in between panels, but this would get pretty gnarly and the drawing code already isn't the easiest to work with.

[teunbrand]

Now with much better spacing for hidden labels:

devtools::load_all("~/packages/ggplot2/")
#> ℹ Loading ggplot2

ggplot(mtcars, aes(mpg, disp)) +
  geom_point() +
  guides(x.sec = "axis", y.sec = "axis") +
  facet_wrap(vars(cyl, vs), axes = "all", axis_labels = "margins")

^{Created on 2023-10-31 with reprex v2.0.2}

[teunbrand]

A small update on how this PR now interacts with newer features.

When using stacked axes, only the first axis in the stack is rendered at interior panels without labels if so directed.

devtools::load_all("~/packages/ggplot2/")
#> ℹ Loading ggplot2

p <- ggplot(mtcars, aes(mpg, disp)) +
  geom_point() +
  facet_wrap(vars(cyl, vs), axes = "all", axis_labels = "margins")

p + guides(x = guide_axis_stack("axis", "axis"),
           y = guide_axis_stack("axis", "axis"))

An exterior r-axis in coord_radial() is treated as typical axes, i.e. labels are censored.

p + coord_radial()

Whereas interior r-axes are rendered in full.

p + coord_radial(end = 1.5 * pi)

^{Created on 2023-12-12 with reprex v2.0.2}

[thomasp85]

Perhaps add an example showing the new functionality

[thomasp85]

Should we add the new arguments in before the deprecated one?

[teunbrand]

Good catch

[thomasp85]

Can this be abstracted away if we are using it multiple places in the code base (both for x and y and in facet_grid and facet_wrap?

[teunbrand]

I'd like this too, but the actual facet_wrap code has very involved code dealing with empty panels (restoring axes for non-empty panels and getting the correct axis sizes). This is right between the matrix(axes$...) and weave_tables_*() steps. We can skip all of this because facet_grid doesn't have empty panels. So while the approach is the same, it would be tricky to unify the actual code.

[thomasp85]

could we at least abstract it away for x and y?

[teunbrand]

I'll see what I can do

[teunbrand]

I figured that facet_wrap() didn't need to measure the axis before dealing with empty panels, so axis measurement and adding it to the table is now wrapped in a weave_axes() helper. This helper is also used in facet_grid() when required.

[thomasp85]

see... I knew you could do it

[thomasp85]

LGTM

[teunbrand]

Thanks for the review Thomas!