r/man/read_delim_arrow.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/csv.R
\name{read_delim_arrow}
\alias{read_delim_arrow}
\alias{read_csv_arrow}
\alias{read_tsv_arrow}
\title{Read a CSV or other delimited file with Arrow}
\usage{
read_delim_arrow(file, delim = ",", quote = "\\"",
  escape_double = TRUE, escape_backslash = FALSE, col_select = NULL,
  skip_empty_rows = TRUE, parse_options = NULL,
  convert_options = NULL, read_options = csv_read_options(),
  as_tibble = TRUE)

read_csv_arrow(file, quote = "\\"", escape_double = TRUE,
  escape_backslash = FALSE, col_select = NULL,
  skip_empty_rows = TRUE, parse_options = NULL,
  convert_options = NULL, read_options = csv_read_options(),
  as_tibble = TRUE)

read_tsv_arrow(file, quote = "\\"", escape_double = TRUE,
  escape_backslash = FALSE, col_select = NULL,
  skip_empty_rows = TRUE, parse_options = NULL,
  convert_options = NULL, read_options = csv_read_options(),
  as_tibble = TRUE)
}
\arguments{
\item{file}{A character path to a local file, or an Arrow input stream}

\item{delim}{Single character used to separate fields within a record.}

\item{quote}{Single character used to quote strings.}

\item{escape_double}{Does the file escape quotes by doubling them?
i.e. If this option is \code{TRUE}, the value \code{""""} represents
a single quote, \code{\"}.}

\item{escape_backslash}{Does the file use backslashes to escape special
characters? This is more general than \code{escape_double} as backslashes
can be used to escape the delimiter character, the quote character, or
to add special characters like \code{\\n}.}

\item{col_select}{A \link[tidyselect:vars_select]{tidy selection specification}
of columns, as used in \code{dplyr::select()}.}

\item{skip_empty_rows}{Should blank rows be ignored altogether? If
\code{TRUE}, blank rows will not be represented at all. If \code{FALSE}, they will be
filled with missings.}

\item{parse_options}{see \code{\link[=csv_parse_options]{csv_parse_options()}}. If given, this overrides any
parsing options provided in other arguments (e.g. \code{delim}, \code{quote}, etc.).}

\item{convert_options}{see \code{\link[=csv_convert_options]{csv_convert_options()}}}

\item{read_options}{see \code{\link[=csv_read_options]{csv_read_options()}}}

\item{as_tibble}{Should the function return a \code{data.frame} or an
\link[=arrow__Table]{arrow::Table}?}
}
\value{
A \code{data.frame}, or an \code{arrow::Table} if \code{as_tibble = FALSE}.
}
\description{
These functions uses the Arrow C++ CSV reader to read into a \code{data.frame}.
Arrow C++ options have been mapped to argument names that follow those of
\code{readr::read_delim()}, and \code{col_select} was inspired by \code{vroom::vroom()}.
}
\details{
\code{read_csv_arrow()} and \code{read_tsv_arrow()} are wrappers around
\code{read_delim_arrow()} that specify a delimiter.

Note that not all \code{readr} options are currently implemented here. Please file
an issue if you encounter one that \code{arrow} should support.

If you need to control Arrow-specific reader parameters that don't have an
equivalent in \code{readr::read_csv()}, you can either provide them in the
\code{parse_options}, \code{convert_options}, or \code{read_options} arguments, or you can
call \code{\link[=csv_table_reader]{csv_table_reader()}} directly for lower-level access.
}