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

[R] Add our philosophy to the dev vignette #30004

Closed
Tracked by #29076
asfimport opened this issue Oct 22, 2021 · 3 comments
Closed
Tracked by #29076

[R] Add our philosophy to the dev vignette #30004

asfimport opened this issue Oct 22, 2021 · 3 comments
Assignees
Milestone

Comments

@asfimport
Copy link

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)

Reporter: Jonathan Keane / @jonkeane
Assignee: Nicola Crane / @thisisnic

PRs and other links:

Note: This issue was originally created as ARROW-14441. Please see the migration documentation for further details.

@asfimport
Copy link
Author

Nicola Crane / @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 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

@asfimport
Copy link
Author

Jonathan Keane / @jonkeane:
I'm a fan of splitting things like this up and that pkgdown setup looks nice.

@asfimport
Copy link
Author

Nicola Crane / @thisisnic:
Issue resolved by pull request 11705
#11705

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants