-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Boilerplate functions #6143
base: main
Are you sure you want to change the base?
Boilerplate functions #6143
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm super excited to see this develop! (esp. for Stats!)
programatically constructing function bodies
I don't have a perfect solution (not thoroughly tested beyond the example) but I thought I'd just throw in some ideas for that, in case the PR will eventually need to do this before it's ready to merge. (I only looked at constructing the layer()
expression - check
feels complicated at a more fundamental level?)
Thanks June! Co-authored-by: June Choe <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for considering my suggestions! Following up w/ just 2 more things I noticed
FWIW, very excited to see something like this happen! {ggdist} has its own boilerplate generation for geoms and stats if you are looking for a comparison point: https://github.com/mjskay/ggdist/blob/master/R/abstract_geom.R Besides reducing maintenance issues I have also moved a lot of documentation into it, so now comprehensive docs of aesthetics and computed variables are generated automatically. Has made my life quite a bit easier. |
Thanks Matthew, it is cool to see that other people have also run into (and solved!) 'there should be hidden parameters' problem I got stuck on as well ^_^ It is interesting (in the good way) to see you opted for a ggproto approach, but I guess this might help coordinate various tasks at once. I also recently was pointed to @corybrunson's https://github.com/corybrunson/ordr/blob/main/build-pre/build-layers.r, which performs a similar task as well. |
Heh oh yeah, I also see your other PR landing on a very similar If this gets combined with other changes, depending on how far that goes in the direction of breaking changes (including the potential for introducing breaking changes to solve other longstanding problems), one solution you might consider is introducing an alternative base Geom class people could inherit from to "opt in" to the newer, cleaner interface. |
Merge branch 'main' into boilerplates # Conflicts: # R/geom-bin2d.R # R/geom-crossbar.R # R/geom-errorbar.R # R/geom-errorbarh.R # R/stat-bin.R # R/stat-ellipse.R # man/geom_errorbarh.Rd # man/geom_histogram.Rd # man/geom_linerange.Rd # man/ggplot2-ggproto.Rd
Alright, stats are covered too now. The method is similar to For Stats, I sometimes had to hide variables, which I did through the
I hide both these cases, but for (1) we might consider a mechanism for explicitly prohibiting these arguments and for (2) whether such parameters should be exposed. This is outside the scope of this PR I think.
This doesn't really narrow it down I'm afraid😅
I don't plan on breaking too much here. This is mostly a convenience function, so I'm looking for a standardised solution. Instead of packing everything in these |
Marking this as ready for review as we decided we don't want a |
This PR aims to (eventually) fix #6142.
Briefly, it introduces
boilerplate()
that can take in a ggproto class and spit out a constructor.This PR is a proof-of-concept because it probably merits some discussion whether we would like to go down this road. As such, the PR only implements
boilerplate()
for Geoms, but can be expanded in the future for Stats and Scales as well, I think.The
boilerplate()
function is used for amenable functions, but not more complex ones. For example,geom_text()
orgeom_boxplot()
perform input checking that we cannot currently easily fit into the boilerplate code.A few notes about the PR:
boilerplate()
takes the class as input. These are the largest diffs.lineend
that would be accepted by theGeom$draw_panel/group()
method, but were set as arguments to the constructor. These are now all exposed.draw_key_polygon()
now actually gets the line settings (lineend, linejoin, linemitre) from the geom instead of having to default these.