r/man/write_csv_arrow.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/csv.R
\name{write_csv_arrow}
\alias{write_csv_arrow}
\title{Write CSV file to disk}
\usage{
write_csv_arrow(
  x,
  sink,
  file = NULL,
  include_header = TRUE,
  col_names = NULL,
  batch_size = 1024L,
  na = "",
  write_options = NULL,
  ...
)
}
\arguments{
\item{x}{\code{data.frame}, \link{RecordBatch}, or \link{Table}}

\item{sink}{A string file path, connection, URI, or \link{OutputStream}, or path in a file
system (\code{SubTreeFileSystem})}

\item{file}{file name. Specify this or \code{sink}, not both.}

\item{include_header}{Whether to write an initial header line with column names}

\item{col_names}{identical to \code{include_header}. Specify this or
\code{include_headers}, not both.}

\item{batch_size}{Maximum number of rows processed at a time. Default is 1024.}

\item{na}{value to write for NA values. Must not contain quote marks. Default
is \code{""}.}

\item{write_options}{see \link[=csv_write_options]{CSV write options}}

\item{...}{additional parameters}
}
\value{
The input \code{x}, invisibly. Note that if \code{sink} is an \link{OutputStream},
the stream will be left open.
}
\description{
Write CSV file to disk
}
\examples{
tf <- tempfile()
on.exit(unlink(tf))
write_csv_arrow(mtcars, tf)
}