1 files changed, 40 insertions, 0 deletions
diff --git a/src/arrow/r/man/FragmentScanOptions.Rd b/src/arrow/r/man/FragmentScanOptions.Rd
new file mode 100644
index 000000000..103d05895
--- /dev/null
+++ b/src/arrow/r/man/FragmentScanOptions.Rd
@@ -0,0 +1,40 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/dataset-format.R
+\name{FragmentScanOptions}
+\alias{FragmentScanOptions}
+\alias{CsvFragmentScanOptions}
+\alias{ParquetFragmentScanOptions}
+\title{Format-specific scan options}
+\description{
+A \code{FragmentScanOptions} holds options specific to a \code{FileFormat} and a scan
+operation.
+}
+\section{Factory}{
+
+\code{FragmentScanOptions$create()} takes the following arguments:
+\itemize{
+\item \code{format}: A string identifier of the file format. Currently supported values:
+\itemize{
+\item "parquet"
+\item "csv"/"text", aliases for the same format.
+}
+\item \code{...}: Additional format-specific options
+
+`format = "parquet"``:
+\itemize{
+\item \code{use_buffered_stream}: Read files through buffered input streams rather than
+loading entire row groups at once. This may be enabled
+to reduce memory overhead. Disabled by default.
+\item \code{buffer_size}: Size of buffered stream, if enabled. Default is 8KB.
+\item \code{pre_buffer}: Pre-buffer the raw Parquet data. This can improve performance
+on high-latency filesystems. Disabled by default.
+\code{format = "text"}: see \link{CsvConvertOptions}. Note that options can only be
+specified with the Arrow C++ library naming. Also, "block_size" from
+\link{CsvReadOptions} may be given.
+}
+}
+
+It returns the appropriate subclass of \code{FragmentScanOptions}
+(e.g. \code{CsvFragmentScanOptions}).
+}
+