ARROW-13834: [R][Documentation] Document the process of creating R bindings for compute kernels and rationale behind conventions #11915
Conversation
|
|
|
This will need to be updated once #11904 is merged |
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Sounds good to me! |
There was a problem hiding this comment.
This looks great! My only two suggestions are:
- Like Alenka said, explain why we are starting with tests. (I totally agree with this move, as someone who often will write tests at the end only to realize later they wouldn't have failed prior to my changes 🤦 .)
- Consider combining steps 3 and 4 into one with subsections. For example, "Step 3: Map the R function to the C++ kernel", "Option a: use direct mapping if there are no options class", "Option b: add explicit implementation to nse_funcs"
r/vignettes/developers/bindings.Rmd
Outdated
| collect() | ||
| ``` | ||
|
|
||
| This is possible as a **binding** has been created between the stringr function |
There was a problem hiding this comment.
This bit has me questioning the term "binding"...whereas str_detect() and match_substring_regex is a 1:1 link, many "bindings" implement a few Arrow compute functions linked together. I'm not sure that either terminology "we created an Arrow binding for str_detect()` or "we created an R binding for match_substring_regex" are correct.
There was a problem hiding this comment.
I love this point, yeah, I see what you mean; this could cause confusion. What about now that I've rephrased it?
This is possible as a binding has been created between the call to the
stringr functionstr_detect()and the Arrow C++ code, here as a direct mapping
tomatch_substring_regex. You can see this for yourself by inspecting the
arrow data query object without retrieving the results viacollect().
There was a problem hiding this comment.
Sorry I missed this last week! I like how you've rephrased it.
There was a problem hiding this comment.
This is looking great. Thank you for the care and detail you've put into this. A few comments and a few minor linter clean ups.
I don't think there will be much, but we should make sure to come back and fix up anything if/when #11904 merges
Co-authored-by: Jonathan Keane <jkeane@gmail.com>
Co-authored-by: Jonathan Keane <jkeane@gmail.com>
Co-authored-by: Jonathan Keane <jkeane@gmail.com>
|
Benchmark runs are scheduled for baseline = f165370 and contender = c9588c5. c9588c5 is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
Add a short intro and a link to the [ARROW-13834](#11915): Walkthrough section content. Closes #12016 from AlenkaF/ARROW-14603 Authored-by: Alenka Frim <frim.alenka@gmail.com> Signed-off-by: Nic Crane <thisisnic@gmail.com>
Add a tab for R bindings in the **Working on the Arrow codebase** section of the guide plus a link to the [ARROW-13834](#11915): Writing Bindings section content. Closes #12018 from AlenkaF/ARROW-14757 Authored-by: Alenka Frim <frim.alenka@gmail.com> Signed-off-by: Nic Crane <thisisnic@gmail.com>
No description provided.