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

• Type: Sub-task
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: R
• External issue URL: https://github.com/apache/arrow/issues/33522
• Assignee: Unassigned
• Reporter: Nicola Crane
• Created: 17/Nov/22 18:35
• Updated: 11/Jan/23 11:59

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.