You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@arrow.apache.org by "Nicola Crane (Jira)" <ji...@apache.org> on 2022/11/17 18:38:00 UTC

[jira] [Updated] (ARROW-18354) [R] Better document the CSV read/parse/convert options we can use with open_dataset()

     [ https://issues.apache.org/jira/browse/ARROW-18354?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Nicola Crane updated ARROW-18354:
---------------------------------
    Description: 
When a user opens a CSV dataset using open_dataset, they can take advantage of a lot of different options which can be specified via {{CsvReadOptions$create()}} etc.

However, as they are passed in via the ellipses ({{...}}) argument, it's not particularly clear to users which arguments are supported or not.  They are not documented in the {{open_dataset()}} docs, and further confused (see the code for {{CsvFileFormat$create()}} by the fact that we support a mix of Arrow and readr parameters (though users can't use both at the same time).

We should better document the arguments we do support.



  was:
When a user opens a CSV dataset using open_dataset, they can take advantage of a lot of different options which can be specified via {{CsvReadOptions$create()}} etc.

However, as they are passed in via the ellipses ({{...}}) argument, it's not particularly clear to users which arguments are supported or not.  They are not documented in the {{open_dataset()}} docs, and further confused (see the code for {{CsvFileFormat$create()}} by the fact that we support a mix of Arrow and readr parameters.

We should better document the arguments we do support.




> [R] Better document the CSV read/parse/convert options we can use with open_dataset()
> -------------------------------------------------------------------------------------
>
>                 Key: ARROW-18354
>                 URL: https://issues.apache.org/jira/browse/ARROW-18354
>             Project: Apache Arrow
>          Issue Type: Sub-task
>          Components: R
>            Reporter: Nicola Crane
>            Priority: Major
>
> When a user opens a CSV dataset using open_dataset, they can take advantage of a lot of different options which can be specified via {{CsvReadOptions$create()}} etc.
> However, as they are passed in via the ellipses ({{...}}) argument, it's not particularly clear to users which arguments are supported or not.  They are not documented in the {{open_dataset()}} docs, and further confused (see the code for {{CsvFileFormat$create()}} by the fact that we support a mix of Arrow and readr parameters (though users can't use both at the same time).
> We should better document the arguments we do support.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)