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

POC: Boilerplate functions #6143

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft

Conversation

teunbrand
Copy link
Collaborator

@teunbrand teunbrand commented Oct 17, 2024

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() or geom_boxplot() perform input checking that we cannot currently easily fit into the boilerplate code.

A few notes about the PR:

  • Because we apply this function for suitable geoms, we had to swap the position of class definition and constructor, as boilerplate() takes the class as input. These are the largest diffs.
  • Some order of arguments are changed, as they are now handled consistently.
  • Many geoms had 'hidden' parameters, i.e. parameters like lineend that would be accepted by the Geom$draw_panel/group() method, but were set as arguments to the constructor. These are now all exposed.
  • In visual tests, I had to accept the changes because draw_key_polygon() now actually gets the line settings (lineend, linejoin, linemitre) from the geom instead of having to default these.
  • I don't have a lot of experience of programatically constructing function bodies. If there is a better way, I'd gladly accept pointers.

@teunbrand teunbrand marked this pull request as draft October 17, 2024 13:19
Copy link
Contributor

@yjunechoe yjunechoe left a 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?)

R/boilerplates.R Outdated Show resolved Hide resolved
R/boilerplates.R Outdated Show resolved Hide resolved
R/boilerplates.R Outdated Show resolved Hide resolved
R/boilerplates.R Outdated Show resolved Hide resolved
Copy link
Contributor

@yjunechoe yjunechoe left a 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

R/boilerplates.R Outdated Show resolved Hide resolved
R/boilerplates.R Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Code duplication
2 participants