POC: Alternative way of determining parameters #6101
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
teunbrand
commented
Sep 12, 2024
Comment on lines
+66
to
+67
| default_params = NULL, | ||
|
|
There was a problem hiding this comment.
- The Geom and Stat classes have a new field that can hold a named list of default parameters.
teunbrand
commented
Sep 12, 2024
Comment on lines
+214
to
+216
| if (!is.null(self$default_params)) { | ||
| return(names(self$default_params)) | ||
| } |
There was a problem hiding this comment.
- We simply return the name of the default parameter list for checking
layer()input. For backward compatibility, if this list isn't present, we resort to the old way of determining input.
teunbrand
commented
Sep 12, 2024
Comment on lines
+433
to
+434
| params <- defaults(c(self$geom_params, self$aes_params), self$geom$default_params) | ||
| self$computed_geom_params <- self$geom$setup_params(data, params) |
There was a problem hiding this comment.
- Before we add computed components to the parameters, we initialise the parameters from the new field
teunbrand
commented
Sep 12, 2024
| @@ -79,7 +81,7 @@ Geom <- ggproto("Geom", | |||
| } | |||
|
|
|||
| # Trim off extra parameters | |||
| params <- params[intersect(names(params), self$parameters())] | |||
| params <- filter_args(params, self$draw_panel) | |||
There was a problem hiding this comment.
- We then filter the parameters on the go in the
compute/draw_layer()andcompute/draw_panel()methods. Implementation offilter_args()in the utils file.
teunbrand
commented
Sep 12, 2024
Comment on lines
+76
to
+77
| default_params = NULL, | ||
|
|
There was a problem hiding this comment.
- We take the same approach with Stats
teunbrand
commented
Sep 12, 2024
Comment on lines
+184
to
+188
| default_params = list( | ||
| na.rm = FALSE, orientation = NA, | ||
| fun.data = NULL, fun = NULL, fun.max = NULL, fun.min = NULL, | ||
| fun.args = list() | ||
| ), |
There was a problem hiding this comment.
- As an example stat, here is how we could implement the default parameters for
StatSummary
teunbrand
commented
Sep 12, 2024
Comment on lines
+181
to
+187
| default_params = list( | ||
| na.rm = FALSE, width = NULL, orientation = NA, outliers = TRUE, | ||
| lineend = "butt", linejoin = "mitre", fatten = 2, outlier.colour = NULL, | ||
| outlier.fill = NULL, outlier.shape = NULL, outlier.size = NULL, | ||
| outlier.stroke = 0.5, outlier.alpha = NULL, notch = FALSE, notchwidth = 0.5, | ||
| staplewidth = 0, varwidth = FALSE, flipped_aes = FALSE | ||
| ), |
There was a problem hiding this comment.
- As a geom example, here is how we could implement the default parameter list for
GeomBoxplot
teunbrand
commented
Sep 12, 2024
| } | ||
|
|
||
| ggname("geom_violin", grobTree( | ||
| GeomPolygon$draw_panel(newdata, ...), | ||
| inject(GeomPolygon$draw_panel(newdata, !!!params)), |
There was a problem hiding this comment.
- Here is a downside of the method: we cannot simply pass dots here as GeomViolin recieves more parameters than GeomPolygon needs. This was the only Geom where this was a problem though.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR explores to fix #1516.
It follows the approach proposed in #1516 (comment).
I've numbered the comments in the code below so it'd be easier to follow.
This PR is currently only implemented for 1 stat and 2 geoms, complying with 'a minimal version' of the approach.
It is for this reason still a POC, and we still have to decide if we like this approach.