diff --git a/r/R/csv.R b/r/R/csv.R index ba3adb792ed37..fd1fad3befe6e 100644 --- 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 index ec1386885b39a..a42905dd18d3a 100644 --- a/r/man/csv_write_options.Rd +++ b/r/man/csv_write_options.Rd @@ -31,3 +31,8 @@ quotes), or "None" (Do not enclose any values in quotes).} \description{ CSV Writing Options } +\examples{ +tf <- tempfile() +on.exit(unlink(tf)) +write_csv_arrow(airquality, tf, write_options = csv_write_options(null_string = "-99")) +} diff --git a/r/man/write_csv_arrow.Rd b/r/man/write_csv_arrow.Rd index 2b0d09ba748c9..9fcca49fadc05 100644 --- a/r/man/write_csv_arrow.Rd +++ b/r/man/write_csv_arrow.Rd @@ -34,7 +34,7 @@ system (\code{SubTreeFileSystem})} \item{na}{value to write for NA values. Must not contain quote marks. Default is \code{""}.} -\item{write_options}{see \link[=CsvWriteOptions]{file reader options}} +\item{write_options}{see \link[=csv_write_options]{CSV write options}} \item{...}{additional parameters} }