Skip to content
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

Fallback for check_subclass() #6119

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ggplot2 (development version)

* When `check_subclass()` fails to find a class directly, it tries to retrieve
the class via constructor functions.
* Built-in `theme_*()` functions now have `ink` and `paper` arguments to control
foreground and background colours respectively (@teunbrand)
* The `summary()` method for ggplots is now more terse about facets
Expand Down
49 changes: 36 additions & 13 deletions R/layer.R
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@
#' `NA`, the default, includes if any aesthetics are mapped.
#' `FALSE` never includes, and `TRUE` always includes.
#' It can also be a named logical vector to finely select the aesthetics to
#' display. To include legend keys for all levels, even
#' when no data exists, use `TRUE`. If `NA`, all levels are shown in legend,
#' display. To include legend keys for all levels, even
#' when no data exists, use `TRUE`. If `NA`, all levels are shown in legend,
#' but unobserved levels are omitted.
#' @param inherit.aes If `FALSE`, overrides the default aesthetics,
#' rather than combining with them. This is most useful for helper functions
Expand Down Expand Up @@ -475,19 +475,42 @@ check_subclass <- function(x, subclass,
env = parent.frame(),
call = caller_env()) {
if (inherits(x, subclass)) {
x
} else if (is_scalar_character(x)) {
name <- paste0(subclass, camelize(x, first = TRUE))
obj <- find_global(name, env = env)

if (is.null(obj) || !inherits(obj, subclass)) {
cli::cli_abort("Can't find {argname} called {.val {x}}.", call = call)
} else {
obj
}
} else {
return(x)
}
if (!is_scalar_character(x)) {
stop_input_type(x, as_cli("either a string or a {.cls {subclass}} object"))
}

# Try getting class object directly
name <- paste0(subclass, camelize(x, first = TRUE))
obj <- find_global(name, env = env)
if (inherits(obj, subclass)) {
return(obj)
}

# Try retrieving class via constructors
name <- snakeize(name)
obj <- find_global(name, env = env, mode = "function")
if (is.function(obj)) {
obj <- obj()
Copy link
Member

Choose a reason for hiding this comment

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

Maybe wrap in try_fetch() and rethrow the error with some additional context. We might end in situations where the constructor can't be called without arguments even though it generally should work

}
# Position constructors return classes directly
if (inherits(obj, subclass)) {
return(obj)
}
# Try prying the class from a layer
if (inherits(obj, "Layer")) {
obj <- switch(
subclass,
Geom = obj$geom,
Stat = obj$stat,
NULL
)
}
if (inherits(obj, subclass)) {
return(obj)
}
cli::cli_abort("Can't find {argname} called {.val {x}}.", call = call)
}

# helper function to adjust the draw_key slot of a geom
Expand Down
16 changes: 16 additions & 0 deletions tests/testthat/test-layer.R
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,22 @@ test_that("layer names can be resolved", {
)
})

test_that("check_subclass can resolve classes via constructors", {

env <- new_environment(list(
geom_foobar = geom_point,
stat_foobar = stat_boxplot,
position_foobar = position_nudge,
guide_foobar = guide_axis_theta
))

expect_s3_class(check_subclass("foobar", "Geom", env = env), "GeomPoint")
expect_s3_class(check_subclass("foobar", "Stat", env = env), "StatBoxplot")
expect_s3_class(check_subclass("foobar", "Position", env = env), "PositionNudge")
expect_s3_class(check_subclass("foobar", "Guide", env = env), "GuideAxisTheta")

})


# Data extraction ---------------------------------------------------------

Expand Down
Loading