Axes at interior panels #4064 #4467

teunbrand · 2021-05-05T19:09:34Z

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)}

Sync branches

smouksassi · 2021-05-05T19:17:03Z

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

Merge branch 'master' of https://github.com/tidyverse/ggplot2 into tidyverse-master # Conflicts: # R/facet-wrap.r

smouksassi · 2021-05-05T19:49:47Z

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

thomasp85 · 2021-11-09T08:28:24Z

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

clauswilke · 2021-11-09T14:09:05Z

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 · 2022-03-23T14:15:42Z

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 · 2022-03-23T15:08:10Z

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

Merge branch 'main' of https://github.com/tidyverse/ggplot2 into facet_axes # Conflicts: # R/facet-grid-.r # R/facet-wrap.r

teunbrand · 2022-03-24T19:19:21Z

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.

Merge branch 'main' into facet_axes # Conflicts: # R/facet-grid-.R # R/facet-wrap.R # man/facet_grid.Rd # tests/testthat/test-facet-.R

teunbrand · 2023-05-22T17:25:55Z

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.

Merge branch 'main' into facet_axes # Conflicts: # R/coord-cartesian-.R

teunbrand · 2023-10-31T10:58:08Z

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}

Merge branch 'main' into facet_axes # Conflicts: # R/facet-grid-.R

teunbrand · 2023-12-12T09:55:29Z

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}

R/facet-grid-.R

…o facet_axes

thomasp85 · 2023-12-14T07:53:34Z

R/facet-grid-.R

+#'   interior axes get labels. When `"margins"`, only the exterior axes get
+#'   labels and the interior axes get none. When `"all_x"` or `"all_y"`, only
+#'   draws the labels at the interior axes in the x- or y-direction
+#'   respectively.
 #' @export
 #' @examples
 #' p <- ggplot(mpg, aes(displ, cty)) + geom_point()


Perhaps add an example showing the new functionality

thomasp85 · 2023-12-14T07:54:02Z

R/facet-grid-.R

@@ -112,7 +122,8 @@ facet_grid <- function(rows = NULL, cols = NULL, scales = "fixed",
                       space = "fixed", shrink = TRUE,
                       labeller = "label_value", as.table = TRUE,
                       switch = NULL, drop = TRUE, margins = FALSE,
-                       facets = deprecated()) {
+                       facets = deprecated(), axes = "margins",
+                       axis.labels = "all") {


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

thomasp85 · 2023-12-14T08:02:47Z

R/facet-grid-.R

+    if (params$draw_axes$x) {
+      # Take facet_wrap approach to axis placement
+      axes$x$top <- matrix(axes$x$top[x_axis_order],
+                           nrow = nrow, ncol = ncol, byrow = TRUE)
+      panel_table <- weave_tables_row(
+        panel_table, axes$x$top, -1,
+        unit(apply(axes$x$top, 1, max_height, value_only = TRUE), "cm"),
+        name = "axis-t", z = 3
+      )
+      axes$x$bottom <- matrix(axes$x$bottom[x_axis_order],
+                              nrow = nrow, ncol = ncol, byrow = TRUE)
+      panel_table <- weave_tables_row(
+        panel_table, axes$x$bottom, 0,
+        unit(apply(axes$x$bottom, 1, max_height, value_only = TRUE), "cm"),
+        name = "axis-b", z = 3
+      )


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?

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.

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

I'll see what I can do

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.

see... I knew you could do it

thomasp85

LGTM

teunbrand · 2023-12-14T21:46:50Z

Thanks for the review Thomas!

teunbrand added 6 commits January 13, 2021 20:09

Merge pull request #1 from tidyverse/master

59850ac

Sync branches

Add axis drawing to fixed scale facet_wrap

8d98452

Add draw.axis argument to facet_grid

b486e7f

Switch to facet_wrap approach when drawing additional axis in facet_grid

f4b3ece

Document draw.axis argument

a0984fe

Add unit tests for draw.axes

16995f7

This comment has been minimized.

Sign in to view

teunbrand added 3 commits May 5, 2021 21:43

Sync with tidyverse master

a7def9a

Merge branch 'master' of https://github.com/tidyverse/ggplot2 into tidyverse-master # Conflicts: # R/facet-wrap.r

resolve conflict

465596b

Merge branch 'tidyverse-master' into facet_axes

5ee44e9

teunbrand added 2 commits March 24, 2022 19:39

Resolve merge conflict

5006c53

Merge branch 'main' of https://github.com/tidyverse/ggplot2 into facet_axes # Conflicts: # R/facet-grid-.r # R/facet-wrap.r

Rename user-facing argument to 'axes'

c97778e

teunbrand added 11 commits May 10, 2023 20:43

Resolve merge

de88a18

Merge branch 'main' into facet_axes # Conflicts: # R/facet-grid-.R # R/facet-wrap.R # man/facet_grid.Rd # tests/testthat/test-facet-.R

Sync latest changes

2b25dcd

Mechanism for label suppression

24b7be0

censoring for wrap

f00d02d

Label censoring for grid

72d5508

Test censoring logic

ce77b7a

Label censoring for wrap

574785c

Test logic for wrap censoring

432c603

Visual test for censoring

7aa2d16

Add NEWS bullet

d6119b1

Merge branch 'main' into facet_axes

3e9a0a2

teunbrand added 2 commits October 31, 2023 09:52

Fix merge conflict

4d0c896

Merge branch 'main' into facet_axes # Conflicts: # R/coord-cartesian-.R

Better panel spacing with empty panels

3970cad

teunbrand added this to the ggplot2 3.5.0 milestone Nov 7, 2023

teunbrand added 4 commits December 12, 2023 09:47

resolve merge conflict

3cc697d

Merge branch 'main' into facet_axes # Conflicts: # R/facet-grid-.R

Only draw first in stack

925edf7

Funnel radial r-axis through CoordCartesian

313bd89

Fix order of theta grobs

1f19415

thomasp85 requested changes Dec 13, 2023

View reviewed changes

R/facet-grid-.R Outdated Show resolved Hide resolved

teunbrand and others added 6 commits December 13, 2023 09:37

use dot.case instead of snake_case for argument

c629845

use dot.case instead of snake_case for argument

214dda5

Merge branch 'facet_axes' of https://github.com/teunbrand/ggplot2 int…

441190c

…o facet_axes

Merge branch 'main' into facet_axes

7d950f7

More snake_case to dot.case conversions

ed56066

Merge branch 'facet_axes' of https://github.com/teunbrand/ggplot2 int…

1a05cf2

…o facet_axes

thomasp85 reviewed Dec 14, 2023

View reviewed changes

teunbrand added 5 commits December 14, 2023 09:50

New args before deprecated args

5d2b39c

add examples

63c4368

Merge branch 'main' into facet_axes

2501629

add weave_axes helper

74993a8

use helper

33a1d6b

thomasp85 approved these changes Dec 14, 2023

View reviewed changes

Merge branch 'main' into facet_axes

657356d

teunbrand merged commit 204c238 into tidyverse:main Dec 14, 2023
12 checks passed

teunbrand deleted the facet_axes branch December 14, 2023 21:46

teunbrand mentioned this pull request Feb 2, 2024

Annotate all facets with axis ticks and labels for fixed scales #4064

Closed

teunbrand mentioned this pull request May 20, 2024

Reduce panel parameter setup in facetted plots #5431

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Axes at interior panels #4064 #4467

Axes at interior panels #4064 #4467

teunbrand commented May 5, 2021

smouksassi commented May 5, 2021

This comment has been minimized.

smouksassi commented May 5, 2021

thomasp85 commented Nov 9, 2021

clauswilke commented Nov 9, 2021

hadley commented Mar 23, 2022

teunbrand commented Mar 23, 2022

teunbrand commented Mar 24, 2022

teunbrand commented May 22, 2023

teunbrand commented Oct 31, 2023

teunbrand commented Dec 12, 2023

thomasp85 Dec 14, 2023

thomasp85 Dec 14, 2023

teunbrand Dec 14, 2023

thomasp85 Dec 14, 2023

teunbrand Dec 14, 2023

thomasp85 Dec 14, 2023

teunbrand Dec 14, 2023

teunbrand Dec 14, 2023

thomasp85 Dec 14, 2023

thomasp85 left a comment

teunbrand commented Dec 14, 2023

Axes at interior panels #4064 #4467

Axes at interior panels #4064 #4467

Conversation

teunbrand commented May 5, 2021

smouksassi commented May 5, 2021

This comment has been minimized.

smouksassi commented May 5, 2021

thomasp85 commented Nov 9, 2021

clauswilke commented Nov 9, 2021

hadley commented Mar 23, 2022

teunbrand commented Mar 23, 2022

teunbrand commented Mar 24, 2022

teunbrand commented May 22, 2023

teunbrand commented Oct 31, 2023

teunbrand commented Dec 12, 2023

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thomasp85 left a comment

Choose a reason for hiding this comment

teunbrand commented Dec 14, 2023