Skip to content

replace parse() with parse_safe() in geom_text() #2867

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.

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

Merged
merged 19 commits into from
Sep 4, 2018
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
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
5 changes: 5 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@
* `position_nudge()` is now more robust and nudges only in the direction
requested. This enables, for example, the horizontal nudging of boxplots
(@clauswilke, #2733).

* `geom_text(..., parse = TRUE)` now correctly renders the expected number of
items instead of silently dropping items that are not valid expressions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not valid isn't quite the right turn of phrase - they are valid; they're just empty. We also fixed handling of multiple expressions in a single string.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, will try to make the comment more accurate.

This is also fixed for `geom_label()` and the axis labels for `geom_sf()`
(@slowkow, #2867).

# ggplot2 3.0.0

Expand Down
2 changes: 1 addition & 1 deletion R/geom-label.R
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ GeomLabel <- ggproto("GeomLabel", Geom,
label.size = 0.25) {
lab <- data$label
if (parse) {
lab <- parse(text = as.character(lab))
lab <- parse_safe(as.character(lab))
}

data <- coord$transform(data, panel_params)
Expand Down
3 changes: 1 addition & 2 deletions R/geom-text.r
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,6 @@ geom_text <- function(mapping = NULL, data = NULL,
)
}


#' @rdname ggplot2-ggproto
#' @format NULL
#' @usage NULL
Expand All @@ -176,7 +175,7 @@ GeomText <- ggproto("GeomText", Geom,
na.rm = FALSE, check_overlap = FALSE) {
lab <- data$label
if (parse) {
lab <- parse(text = as.character(lab))
lab <- parse_safe(as.character(lab))
}

data <- coord$transform(data, panel_params)
Expand Down
19 changes: 15 additions & 4 deletions R/sf.R
Original file line number Diff line number Diff line change
Expand Up @@ -476,10 +476,6 @@ CoordSf <- ggproto("CoordSf", CoordCartesian,
if (!is.null(graticule$plot12))
graticule$degree_label[!graticule$plot12] <- NA

# parse labels into expressions if required
if (any(grepl("degree", graticule$degree_label)))
graticule$degree_label <- lapply(graticule$degree_label, function(x) parse(text = x)[[1]])

graticule
},

Expand Down Expand Up @@ -511,6 +507,21 @@ CoordSf <- ggproto("CoordSf", CoordCartesian,
graticule$y_start <- sf_rescale01_x(graticule$y_start, y_range)
graticule$y_end <- sf_rescale01_x(graticule$y_end, y_range)

# Convert 'degree' to the degree symbol
parse_ids <- grepl("\\bdegree\\b", graticule$degree_label)
if (any(parse_ids)) {
graticule$degree_label <- Map(
function(parse_id, label) {
if (parse_id) {
parse(text = label)[[1]]
} else {
as.expression(label)[[1]]
}
},
parse_ids, graticule$degree_label
)
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you mind moving this code block into the fixup_graticule_labels() function?

list(
x_range = x_range,
y_range = y_range,
Expand Down
18 changes: 18 additions & 0 deletions R/utilities.r
Original file line number Diff line number Diff line change
Expand Up @@ -430,3 +430,21 @@ is_column_vec <- function(x) {
dims <- dim(x)
length(dims) == 2L && dims[[2]] == 1L
}

# Parse takes takes n strings and returns n expressions
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed "takes takes". Since I asked for one more substantive change, maybe you could fix this also.

# See https://github.com/tidyverse/ggplot2/issues/2864 for discussion
#
# parse(text = c("alpha", "", "gamma"))
# #> expression(alpha, gamma)
#
# parse_safe(text = c("alpha", "", "gamma"))
# #> expression(alpha, NA, gamma)
#
parse_safe <- function(text) {
out <- vector("expression", length(text))
for (i in seq_along(text)) {
expr <- parse(text = text[[i]])
out[[i]] <- if (length(expr) == 0) NA else expr[[1]]
}
out
}
49 changes: 49 additions & 0 deletions tests/testthat/test-utilities.r
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,52 @@ test_that("find_args behaves correctly", {
# Defaults are overwritten
expect_true(test_fun(arg2 = TRUE)$arg2)
})

test_that("parse_safe works with simple expressions", {
expect_equal(
parse_safe(c("", " ", " ")),
expression(NA, NA, NA)
)

expect_equal(
parse_safe(c("A", "B", "C")),
expression(A, B, C)
)

expect_equal(
parse_safe(c("alpha", "", "gamma", " ")),
expression(alpha, NA, gamma, NA)
)

expect_equal(
parse_safe(c(NA, "a", NA, "alpha")),
expression(NA, a, NA, alpha)
)

expect_equal(
parse_safe(factor(c("alpha", "beta", ""))),
expression(2, 3, 1)
)
})

test_that("parse_safe works with multi expressions", {
expect_equal(
parse_safe(c(" \n", "\n ", " \n \n ")),
expression(NA, NA, NA)
)

expect_equal(
parse_safe(c("alpha ~ beta", "beta \n gamma", "")),
expression(alpha ~ beta, beta, NA)
)

expect_equal(
parse_safe(c("alpha ~ beta", " ", "integral(f(x) * dx, a, b)")),
expression(alpha ~ beta, NA, integral(f(x) * dx, a, b))
)

expect_equal(
parse_safe(c(NA, 1, 2, "a \n b")),
expression(NA, 1, 2, a)
)
})