Tags at panels #5167

teunbrand · 2023-01-30T21:26:42Z

This PR aims to fix #4297.

Briefly, it adds the option to use plot.tag.position = c({position}, "panel") and draw the plot tag in the panel. It should also work with the patchwork package.

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

p <- ggplot(mpg, aes(displ, hwy)) +
  geom_point()

p +
  labs(tag = "A)") +
  theme(plot.tag.position = c("panel", "topright"))

library(patchwork)

(p + p) + plot_annotation(tag_levels = 'A') &
  theme(plot.tag.position = "panel")

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

Some side-notes:

I separated out the tag logic from the already enormous ggplot_gtable.ggplot_built() method. I refactored a little bit along the way.
Instead of adding yet another theme argument, I expanded the use of the already existing one. I think a lot in the theme, related to positions and alignments, is named confusingly, so I didn't want to pile on this already dizzying naming scheme (also nagged about this here).
I once again ran into this bug, so I fixed it in the same way.

teunbrand · 2023-01-30T21:27:26Z

R/plot-build.r

+  # Initialise the tag margins
+  table <- gtable_add_padding(table, unit(0, "pt"))


Patchwork for some reason assumes this padding is present regardless of whether it was needed, so I left this in.

yes, thanks... We should generally try to be predictable wrt the gtable structure that ggplot2 produces as it makes aligning multiple plots easier for patchwork

That makes good sense to me :)

teunbrand · 2023-01-30T21:28:27Z

R/plot-build.r

+    if (top)    table$heights <- unit.c(height, table$heights[-1])
+    if (left)   table$widths  <- unit.c(width,  table$widths[-1])
+    if (right)  table$widths  <- unit.c(table$widths[-n_col],  width)
+    if (bottom) table$heights <- unit.c(table$heights[-n_row], height)


I think this pattern was some workaround for grid units not handling subassignment in R3.2 and earlier. Can we subassign units now?

teunbrand · 2023-02-04T12:38:04Z

Should merge #5175 before this. Then update this PR to revert changes in 5dd6c2a.

This reverts commit 5dd6c2a.

thomasp85 · 2023-03-14T10:21:45Z

With this PR there will be 3 different placement strategies for tags. Either in the margin (adding space for it), on top of the full plot area (not adding space), or in the panel area (not adding space). Do all three have a name in this new API?

teunbrand · 2023-03-21T18:30:43Z

Currently, not all three placements have names, but for consistency's sake, maybe they should.

We could make it so that we have the following names:

"margin" for how currently character placement works.
- "topleft" would be the same as c("margin", "topleft").
"plot" for how currently numeric placement works.
- c("plot", "topleft") would then mean the same as c(0, 1).
"panel" for the new placement works.
- c("panel", "topleft")

teunbrand · 2023-03-21T18:59:50Z

I also found that if you use the margin placement, hjust/vjust is ignored. This is isn't as much as issue if you use the plot placement, as the two numbers you give essentially determine the hjust/vjust.

To illustrate:

library(ggplot2)

p <- ggplot(mpg, aes(displ, hwy)) +
  geom_point() +
  labs(tag = "Foobar")

In the plot below, I'd expect the tag to be in the top left, with a left margin for the plot, but not a top margin for the plot.

p + theme(plot.tag.position = "left",
          plot.tag = element_text(vjust = 1))

Likewise, here I would have expected the text to be at the top right, with a plot margin on top but not on the right.

p + theme(plot.tag.position = "top",
          plot.tag = element_text(hjust = 1))

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

I feel that this might be a separate issue, but since I'm tinkering with this code anyway, might as well include adherence to hjust/vjust settings.

thomasp85 · 2023-03-22T13:21:04Z

I like the "margin" name and think we should include that for completeness...

As for alignment, it works "correctly" right now in that it is perfectly aligned to the textbook that closely wraps the tag text. It is not given that the alignment is relative to the panel size.

I can see the argument for having it as you describe because the alignment is right now useless but I don't think it is obviously a bug as it is

teunbrand · 2023-03-27T17:56:01Z

One could now do these things:

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

p <- ggplot(mpg, aes(displ, hwy)) +
  geom_point() +
  labs(tag = "Foobar")

p + theme(plot.tag.position = c("panel", "topleft"))

p + theme(plot.tag.position = c("plot", "bottomright"))

p + theme(plot.tag.position = c("margin", "top"))

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

NEWS.md

thomasp85 · 2023-04-14T08:18:41Z

Can we somehow make this new alignment work with numeric positions..?

teunbrand · 2023-04-15T05:23:29Z

We could in theory, but the way it is setup right now it isn't straightforward, as we cannot pass a mixed type character/numeric to the plot.tag.position setting. There is currently some flexibility of placement, in that you can set the hjust/vjust if only one of the directions is fixed:

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

p <- ggplot(mpg, aes(displ, hwy)) +
  geom_point() +
  labs(tag = "Foobar")

p + theme(plot.tag.position = c("panel", "top"),
          plot.tag = element_text(hjust = 0.75))

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

I think we might be able to extend this by not having the position default to 'topleft' for the 'panel' setting.

thomasp85 · 2023-04-15T06:55:20Z

yeah, I know the limitations of the current setup. I was thinking we should maybe considering a different setup such as providing an additional theme element (e.g. plot.tag.location) that holds the margin/plot/panel info... this would also bring it somewhat more in line with other location styles

teunbrand · 2023-04-15T16:50:06Z

We could make that work, but how should a numeric value interact with plot.tag.location = "margin"?

thomasp85 · 2023-04-21T07:53:03Z

yeah, that's a good question...

But I think having that not work (and documented) is better than the alternative

teunbrand · 2023-04-26T19:29:10Z

I'm just throwing an error now with numeric plot.tag.position and plot.tag.location = "margin".

thomasp85

LGTM

teunbrand added 10 commits January 30, 2023 21:48

Fix calc_element for character/numeric input

5dd6c2a

Add function for adding tag to table

38f3d9f

Decommission previous tag logic

72387dd

Update test

827dd5e

Strictness about manual placement

fafc7ca

Adjust argument description

f8ce3b4

Roxygenate

82fa7cb

Add NEWS bullet

6ec020a

Add test

60f7754

Simplify padding

9c571c0

teunbrand commented Jan 30, 2023

View reviewed changes

teunbrand mentioned this pull request Feb 2, 2023

Theme element dual inheritance #5175

Merged

teunbrand marked this pull request as draft February 4, 2023 12:36

teunbrand and others added 3 commits February 21, 2023 19:55

Revert "Fix calc_element for character/numeric input"

bc3e4ce

This reverts commit 5dd6c2a.

Merge branch 'panel_tag' into main_temp

2adbfee

Merge pull request #11 from teunbrand/main_temp

a9d05e7

teunbrand marked this pull request as ready for review February 21, 2023 18:59

Merge branch 'main' into panel_tag

f99b8c6

teunbrand added 2 commits March 27, 2023 19:52

Make placement choices more consistent

5140faa

Tinker tests

2f1a230

Fix typos

6b7ca5c

thomasp85 reviewed Apr 14, 2023

View reviewed changes

NEWS.md Outdated Show resolved Hide resolved

teunbrand added 5 commits April 26, 2023 20:36

Merge branch 'main' into panel_tag

9dd6875

Add plot.tag.location theme element

6f55da5

Use plot.tag.location in tag construction

91c9bec

Cover all combinations in tests

3b18526

Update bullet

b3cb680

thomasp85 approved these changes May 2, 2023

View reviewed changes

teunbrand merged commit f89212d into tidyverse:main May 2, 2023

teunbrand deleted the panel_tag branch May 2, 2023 19:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tags at panels #5167

Tags at panels #5167

teunbrand commented Jan 30, 2023 •

edited

Loading

teunbrand Jan 30, 2023

thomasp85 Feb 22, 2023

teunbrand Feb 22, 2023

teunbrand Jan 30, 2023

teunbrand commented Feb 4, 2023 •

edited

Loading

thomasp85 commented Mar 14, 2023

teunbrand commented Mar 21, 2023

teunbrand commented Mar 21, 2023 •

edited

Loading

thomasp85 commented Mar 22, 2023

teunbrand commented Mar 27, 2023

thomasp85 commented Apr 14, 2023

teunbrand commented Apr 15, 2023

thomasp85 commented Apr 15, 2023

teunbrand commented Apr 15, 2023

thomasp85 commented Apr 21, 2023

teunbrand commented Apr 26, 2023

thomasp85 left a comment

		# Initialise the tag margins
		table <- gtable_add_padding(table, unit(0, "pt"))

Tags at panels #5167

Tags at panels #5167

Conversation

teunbrand commented Jan 30, 2023 • edited Loading

teunbrand Jan 30, 2023

Choose a reason for hiding this comment

thomasp85 Feb 22, 2023

Choose a reason for hiding this comment

teunbrand Feb 22, 2023

Choose a reason for hiding this comment

teunbrand Jan 30, 2023

Choose a reason for hiding this comment

teunbrand commented Feb 4, 2023 • edited Loading

thomasp85 commented Mar 14, 2023

teunbrand commented Mar 21, 2023

teunbrand commented Mar 21, 2023 • edited Loading

thomasp85 commented Mar 22, 2023

teunbrand commented Mar 27, 2023

thomasp85 commented Apr 14, 2023

teunbrand commented Apr 15, 2023

thomasp85 commented Apr 15, 2023

teunbrand commented Apr 15, 2023

thomasp85 commented Apr 21, 2023

teunbrand commented Apr 26, 2023

thomasp85 left a comment

Choose a reason for hiding this comment

teunbrand commented Jan 30, 2023 •

edited

Loading

teunbrand commented Feb 4, 2023 •

edited

Loading

teunbrand commented Mar 21, 2023 •

edited

Loading