This is an automated email from the ASF dual-hosted git repository.
jonkeane pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new ac581fd2a8 GH-38216: [R] open_dataset(format = "json") not documented
(#38258)
ac581fd2a8 is described below
commit ac581fd2a87b35c872cf334bb147851fe1287714
Author: Divyansh200102 <[email protected]>
AuthorDate: Tue Oct 17 23:47:32 2023 +0530
GH-38216: [R] open_dataset(format = "json") not documented (#38258)
fixes #38216
* Closes: #38216
Lead-authored-by: Divyansh200102 <[email protected]>
Co-authored-by: Divyansh200102
<[email protected]>
Co-authored-by: Jonathan Keane <[email protected]>
Signed-off-by: Jonathan Keane <[email protected]>
---
r/R/dataset.R | 3 ++-
r/man/open_dataset.Rd | 7 ++++---
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/r/R/dataset.R b/r/R/dataset.R
index 90e6516927..2400d08393 100644
--- a/r/R/dataset.R
+++ b/r/R/dataset.R
@@ -112,7 +112,8 @@
#' * "csv"/"text", aliases for the same thing (because comma is the default
#' delimiter for text files
#' * "tsv", equivalent to passing `format = "text", delimiter = "\t"`
-#'
+#' * "json", for JSON format datasets Note: only newline-delimited JSON (aka
ND-JSON) datasets
+#' are currently supported
#' Default is "parquet", unless a `delimiter` is also specified, in which case
#' it is assumed to be "text".
#' @param ... additional arguments passed to `dataset_factory()` when `sources`
diff --git a/r/man/open_dataset.Rd b/r/man/open_dataset.Rd
index 94b537a1d3..7c3d32289f 100644
--- a/r/man/open_dataset.Rd
+++ b/r/man/open_dataset.Rd
@@ -74,10 +74,11 @@ only version 2 files are supported
\item "csv"/"text", aliases for the same thing (because comma is the default
delimiter for text files
\item "tsv", equivalent to passing \verb{format = "text", delimiter = "\\t"}
-}
-
+\item "json", for JSON format datasets Note: only newline-delimited JSON (aka
ND-JSON) datasets
+are currently supported
Default is "parquet", unless a \code{delimiter} is also specified, in which
case
-it is assumed to be "text".}
+it is assumed to be "text".
+}}
\item{factory_options}{list of optional FileSystemFactoryOptions:
\itemize{
