Add examples for csv_convert_options

thisisnic · Oct 7, 2023 · b754956 · b754956
1 parent 64e7736
commit b754956
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/r/R/csv.R b/r/R/csv.R
@@ -743,6 +743,12 @@ TimestampParser$create <- function(format = NULL) {
 #'    (b) a character vector of [strptime][base::strptime()] parse strings; or
 #'    (c) a list of [TimestampParser] objects.
 #'
+#' @examples
+#' tf <- tempfile()
+#' on.exit(unlink(tf))
+#' writeLines('x\n1\nNULL\n2\nNA', tf)
+#' read_csv_arrow(tf, convert_options = csv_convert_options(null_values =  c("", "NA", "NULL")))
+#' open_csv_dataset(tf, convert_options = csv_convert_options(null_values =  c("", "NA", "NULL")))
 #' @export
 csv_convert_options <- function(check_utf8 = TRUE,
                                      null_values = c("", "NA"),

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