[jira] [Comment Edited] (ARROW-14441) [R] Add our philosophy to the dev vignette

["Nicola Crane (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ARROW-14441?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17433656#comment-17433656 ] 

Nicola Crane edited comment on ARROW-14441 at 10/25/21, 9:45 AM:
-----------------------------------------------------------------

I am currently working on a document around writing compute bindings, and this feels like it'd fit alongside that.  I'm wondering if, instead of 1 long vignette, we need a series of shorter articles for the pkgdown site, like in this example? [https://pkgdown.r-lib.org/reference/build_articles.html]


was (Author: thisisnic):
I am currently working on a document around writing compute bindings, and this feels like it'd fit alongside that.  I'm wondering if, instead of a huge vignette, we need a series of shorter articles for the pkgdown site, like in this example? https://pkgdown.r-lib.org/reference/build_articles.html

> [R] Add our philosophy to the dev vignette
> ------------------------------------------
>
>                 Key: ARROW-14441
>                 URL: https://issues.apache.org/jira/browse/ARROW-14441
>             Project: Apache Arrow
>          Issue Type: Improvement
>          Components: R
>            Reporter: Jonathan Keane
>            Priority: Major
>
> This isn't necessarily limited to CSVs, but we should have this philosophy in our developing vignette 
> The general approach we've done with CSV things in the past is:
> (1) support the readr signature to the best extent we can, translating to the arrow parameter names internally;
> (2) allow someone to pass the arrow options (CsvReadOptions etc.) directly, in case they want to do things at a lower level
> (3) where necessary add extra args to the readr signature for features that don't exist in R but do in arrow (e.g. schema)
> This is our general philosophy: present things to the R user in a way that is least surprising to them (most follows R conventions) and also provide access to all of Arrow's features (sometimes that's extra args, sometimes it's the arrow_ prefixed functions in dplyr, sometimes it's just the lower-level R6 objects and methods that more closely follow the C++ interface)



--
This message was sent by Atlassian Jira
(v8.3.4#803005)