Add example for csv_write_options

thisisnic · Oct 7, 2023 · cf6a751 · cf6a751
1 parent ccf04ff
commit cf6a751
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/r/R/csv.R b/r/R/csv.R
@@ -570,6 +570,10 @@ readr_to_csv_write_options <- function(col_names = TRUE,
 #'    rendering can contain quotes itself (e.g. strings or binary values)), "AllValid" (Enclose all valid values in
 #'    quotes), or "None" (Do not enclose any values in quotes).
 #'
+#' @examples
+#' tf <- tempfile()
+#' on.exit(unlink(tf))
+#' write_csv_arrow(airquality, tf, write_options = csv_write_options(null_string = "-99"))
 #' @export
 csv_write_options <-  function(include_header = TRUE,
                                    batch_size = 1024L,
@@ -846,7 +850,7 @@ readr_to_csv_convert_options <- function(na,
 #' @param batch_size Maximum number of rows processed at a time. Default is 1024.
 #' @param na value to write for NA values. Must not contain quote marks. Default
 #'     is `""`.
-#' @param write_options see [file reader options][CsvWriteOptions]
+#' @param write_options see [CSV write options][csv_write_options]
 #' @param ... additional parameters
 #'
 #' @return The input `x`, invisibly. Note that if `sink` is an [OutputStream],

diff --git a/r/man/csv_write_options.Rd b/r/man/csv_write_options.Rd
diff --git a/r/man/write_csv_arrow.Rd b/r/man/write_csv_arrow.Rd