MINOR: [R] Clarify read_json_arrow() docs

A quick PR to clarify `read_json_arrow()` docs I found confusing while benchmarking. Specifically, specifies the function - is for ndjson (as opposed to say the many json formats to which pandas can write a dataframe) - handles compression - handles implicit and explicit nulls (was in the example, but not previously stated) Open to changes, but do feel these docs need to at least explicitly say "ndjson" somewhere. Closes apache#13133 from alistaire47/chore/read-json-docs Lead-authored-by: Edward Visel <[email protected]> Co-authored-by: Neal Richardson <[email protected]> Signed-off-by: Neal Richardson <[email protected]>
khwilson · May 18, 2022 · 663dc32 · 663dc32
1 parent d2cbe9e
commit 663dc32
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/r/R/json.R b/r/R/json.R
@@ -17,7 +17,11 @@
 
 #' Read a JSON file
 #'
-#' Using [JsonTableReader]
+#' Wrapper around [JsonTableReader] to read a newline-delimited JSON (ndjson) file into a
+#' data frame or Arrow Table.
+#'
+#' If passed a path, will detect and handle compression from the file extension
+#' (e.g. `.json.gz`). Accepts explicit or implicit nulls.
 #'
 #' @inheritParams read_delim_arrow
 #' @param schema [Schema] that describes the table.

diff --git a/r/man/read_json_arrow.Rd b/r/man/read_json_arrow.Rd