r/man/convert_array_stream.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/convert-array-stream.R
\name{convert_array_stream}
\alias{convert_array_stream}
\alias{collect_array_stream}
\title{Convert an Array Stream into an R vector}
\usage{
convert_array_stream(array_stream, to = NULL, size = NULL, n = Inf)

collect_array_stream(array_stream, n = Inf, schema = NULL, validate = TRUE)
}
\arguments{
\item{array_stream}{A \link[=as_nanoarrow_array_stream]{nanoarrow_array_stream}.}

\item{to}{A target prototype object describing the type to which \code{array}
should be converted, or \code{NULL} to use the default conversion as
returned by \code{\link[=infer_nanoarrow_ptype]{infer_nanoarrow_ptype()}}. Alternatively, a function can be
passed to perform an alternative calculation of the default ptype as
a function of \code{array} and the default inference of the prototype.}

\item{size}{The exact size of the output, if known. If specified,
slightly more efficient implementation may be used to collect the output.}

\item{n}{The maximum number of batches to pull from the array stream.}

\item{schema}{A \link[=as_nanoarrow_schema]{nanoarrow_schema} or \code{NULL} to guess
based on the first schema.}

\item{validate}{Use \code{FALSE} to skip the validation step (i.e., if you
know that the arrays are valid).}
}
\value{
\itemize{
\item \code{convert_array_stream()}: An R vector of type \code{to}.
\item \code{collect_array_stream()}: A \code{list()} of \link[=as_nanoarrow_array]{nanoarrow_array}
}
}
\description{
Converts \code{array_stream} to the type specified by \code{to}. This is a low-level
interface; most users should use \code{as.data.frame()} or \code{as.vector()} unless
finer-grained control is needed over the conversion. See \code{\link[=convert_array]{convert_array()}}
for details of the conversion process; see \code{\link[=infer_nanoarrow_ptype]{infer_nanoarrow_ptype()}} for
default inferences of \code{to}.
}
\examples{
stream <- as_nanoarrow_array_stream(data.frame(x = 1:5))
str(convert_array_stream(stream))
str(convert_array_stream(stream, to = data.frame(x = double())))

stream <- as_nanoarrow_array_stream(data.frame(x = 1:5))
collect_array_stream(stream)

}