Make graticule labeling configurable #2849

clauswilke · 2018-08-23T18:13:11Z

This PR makes graticule labeling configurable. This closes #2846.

Edit 9/14/2018: I've removed outdated examples. New examples are provided below.

hadley · 2018-09-12T19:59:43Z

R/sf.R

+#'   which side of the plot. Meridians are indicated by `"E"` (for East) and
+#'   parallels by `"N"` (for North). Default is `"--EN"`, which specifies
+#'   (clockwise from the top) no labels on the top, none on the right, meridians
+#'   on the bottom, and paralleles on the left. Alternatively, this setting could have been


paralleles -> parallels? (I'm assuming that's a typo not a map term I'm unfamiliar with)

hadley · 2018-09-12T20:00:00Z

R/sf.R

+  if (is.character(label_axes)) {
+    label_axes <- parse_axes_labeling(label_axes)
+  } else if (!is.list(label_axes)) {
+    warning(


I'd rather make this an error

hadley · 2018-09-12T20:00:14Z

R/sf.R

+  if (is.character(label_graticules)) {
+    label_graticules <- unlist(strsplit(label_graticules, ""))
+  } else {
+    warning(


hadley · 2018-09-12T20:01:52Z

R/sf.R

+#'   their west end, whereas `label_graticules = "EW"` would label parallels at both
+#'   ends and meridians not at all. Because meridians and parallels can in general
+#'   intersect with any side of the plot panel, for any choice of `label_graticules` labels
+#'   are not guaranteed to reside on only one particular side of the plot panel.


Include an example? Or maybe it's time to start a sf vignette? (Which would be a separate issue)

I think this is a separate issue. Currently, all the sf documentation is combined into one .Rd file, and I think we're accumulating too much material to document everything carefully in this way. My proposal would be to start breaking things up, e.g. make a separate .Rd file just for coord_sf(). There it would make sense to give more specific examples of how coord_sf() works.

(As an aside, I would also like to consider breaking up the file sf.R into coord-sf.R, geom-sf.R, stat-sf.R, etc.)

hadley · 2018-09-12T20:02:23Z

@batpigandme can you please do a proof reading pass over the docs?

clauswilke · 2018-09-14T14:21:14Z

Before I merge this, I wanted to have one more quick discussion about the API. I have added two new parameters to coord_sf(), label_graticule and label_axes. I'll provide some examples of how they work and then bring up a few points about the parameter names.

library(sf)
#> Linking to GEOS 3.6.1, GDAL 2.1.3, proj.4 4.9.3
library(ggplot2) 

nc <- st_read(system.file("gpkg/nc.gpkg", package="sf"), quiet = TRUE)

# default
ggplot() + geom_sf(aes(fill = AREA), data=nc) + coord_sf()

# default with rotated coordinate system
ggplot() + geom_sf(aes(fill = AREA), data=nc) + coord_sf(crs = 3338)

# NSEW specification
ggplot() + geom_sf(aes(fill = AREA), data=nc) + 
  coord_sf(label_graticule = "NE")

# axis labeling specification
ggplot() + geom_sf(aes(fill = AREA), data=nc) + 
  coord_sf(label_axes = list(top = "E", left = "N"))

# combining both specifications, rotated coordinate system
ggplot() + geom_sf(aes(fill = AREA), data=nc) + 
  coord_sf(
    crs = 3338,
    label_graticule = "N",
    label_axes = "-NE-"
  )

Created on 2018-09-14 by the reprex package (v0.2.0).

I'm not fully happy with the parameter names. I think graticule_labeling and axis_labeling may be preferably. The downside of that naming is that then the two parameters don't start with the same word. Since they do very similar things, having the parameters start with the same name is useful.

@hadley @batpigandme Any opinion on the naming? Any alternative suggestions that would be better?

hadley · 2018-09-14T14:37:58Z

I think a common prefix is better than a common suffix. I share your sense that the current names are suboptimal, but I can't think of any better. This definitely feels complex enough (but not unnecessarily so) that we're going to soon need a bigger vignette/article discussing how to label maps.

batpigandme · 2018-09-15T12:20:29Z

NEWS.md

@@ -6,6 +6,10 @@

 *   `coord_sf()` now respects manual setting of axis tick labels (@clauswilke,
    #2857, #2881).
+
+*   `coord_sf()` now accepts two new parameters `label_graticule` and `label_axes`


Because I'm the worst, can we offset the params as appositives? "…two new parameters, label_graticule and label_axes`,…"

batpigandme · 2018-09-15T12:21:42Z

R/sf.R

@@ -622,23 +746,85 @@ sf_rescale01_x <- function(x, range) {
 }


-#' @param crs Use this to select a specific CRS. If not specified, will
-#'   use the CRS defined in the first layer.
+#' @param crs Use this to select a specific coordinate reference system (CRS).


🎉 Every time you spell out an intiialism, an angel gets its wings.

batpigandme · 2018-09-15T12:22:57Z

R/sf.R

+#'   parallels by `"N"` (for North). Default is `"--EN"`, which specifies
+#'   (clockwise from the top) no labels on the top, none on the right, meridians
+#'   on the bottom, and parallels on the left. Alternatively, this setting could have been
+#'   specified with `list(left = "N", bottom = "E")`.


Should we have the order be consistent here? (i.e. bottom = "E", left = "N")

batpigandme · 2018-09-15T12:32:30Z

R/sf.R

+#'   should be labeled on their east or west end points, respectively. Thus,
+#'   `label_graticule = "SW"` would label meridians at their south end and parallels at
+#'   their west end, whereas `label_graticule = "EW"` would label parallels at both
+#'   ends and meridians not at all. Because meridians and parallels can in general


I want to make sure I understand this last sentence correctly (and, if I don't, perhaps some clarification is in order). label_graticule is oriented to the map, not to the plot panel. So, label_graticule = "SW", for example, is not guaranteed to be in the bottom left corner of the plot panel. Is that kinda right?

Yes, you understand correctly. In my experience, the result from label_graticule specifications can look unexpected for rotated coordinate systems, and it usually takes me a minute or so to verify that it's actually correct. See example.

library(sf) #> Linking to GEOS 3.6.1, GDAL 2.1.3, proj.4 4.9.3 library(ggplot2) nc <- st_read(system.file("gpkg/nc.gpkg", package="sf"), quiet = TRUE) ggplot() + geom_sf(aes(fill = AREA), data=nc) + coord_sf(crs = 3338, label_graticule = "SW")

Created on 2018-09-15 by the reprex package (v0.2.0).

Great. Yeah, it makes sense, I just wanted to double check.

lock · 2019-03-14T17:07:08Z

This old issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with reprex) and link to this issue. https://reprex.tidyverse.org/

This was referenced Aug 23, 2018

geom_sf() does not respect position argument of scale_y_continuous() #2846

Closed

Attribute plot12 in st_graticule() is not documented and not sufficiently general r-spatial/sf#828

Closed

clauswilke force-pushed the issue-2846-coord_sf branch from ee2efae to e7d05ea Compare August 24, 2018 02:17

clauswilke mentioned this pull request Sep 12, 2018

Release a quick ggplot2 3.0.1? #2831

Closed

hadley approved these changes Sep 12, 2018

View reviewed changes

hadley requested a review from batpigandme September 12, 2018 20:02

clauswilke mentioned this pull request Sep 12, 2018

Release ggplot2 3.1.0 #2890

Closed

25 tasks

clauswilke added 11 commits September 13, 2018 17:30

draw graticule labels on all sides; not yet configurable.

e51481f

Make graticule labeling configurable. Closes tidyverse#2846.

2738605

update documentation

bc3b2d5

specify graticule labeling via string

7311956

graticule labeling via cardinal coordinates

de3a9d6

allow labeling by graticules and panel sides at the same time

ace940b

fix documentation

b0f2b04

fix news bullet

a4e8bf4

remove outdated code

98b3512

fix typo in documentation

fa19ded

rebase, fix documentation

6a5dbd0

clauswilke force-pushed the issue-2846-coord_sf branch from 470fb23 to 6a5dbd0 Compare September 14, 2018 14:12

update NEWS

37f8e51

batpigandme approved these changes Sep 15, 2018

View reviewed changes

update NEWS and documentation

55c8b11

clauswilke merged commit 484a220 into tidyverse:master Sep 15, 2018

clauswilke deleted the issue-2846-coord_sf branch September 15, 2018 16:14

lock bot locked and limited conversation to collaborators Mar 14, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make graticule labeling configurable #2849

Make graticule labeling configurable #2849

clauswilke commented Aug 23, 2018 •

edited

Loading

hadley Sep 12, 2018

clauswilke Sep 14, 2018

hadley Sep 12, 2018

clauswilke Sep 14, 2018

hadley Sep 12, 2018

clauswilke Sep 14, 2018

hadley Sep 12, 2018

clauswilke Sep 14, 2018

hadley commented Sep 12, 2018

clauswilke commented Sep 14, 2018

hadley commented Sep 14, 2018

batpigandme Sep 15, 2018

clauswilke Sep 15, 2018

batpigandme Sep 15, 2018

batpigandme Sep 15, 2018

clauswilke Sep 15, 2018

batpigandme Sep 15, 2018

clauswilke Sep 15, 2018

batpigandme Sep 15, 2018

lock bot commented Mar 14, 2019

Make graticule labeling configurable #2849

Make graticule labeling configurable #2849

Conversation

clauswilke commented Aug 23, 2018 • edited Loading

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

hadley commented Sep 12, 2018

clauswilke commented Sep 14, 2018

hadley commented Sep 14, 2018

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

lock bot commented Mar 14, 2019

clauswilke commented Aug 23, 2018 •

edited

Loading