From e6918187568dbd01842d8d1d2c808ce16a894239 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 21 Apr 2024 13:54:28 +0200 Subject: Adding upstream version 18.2.2. Signed-off-by: Daniel Baumann --- src/arrow/r/man/FeatherReader.Rd | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 src/arrow/r/man/FeatherReader.Rd (limited to 'src/arrow/r/man/FeatherReader.Rd') diff --git a/src/arrow/r/man/FeatherReader.Rd b/src/arrow/r/man/FeatherReader.Rd new file mode 100644 index 000000000..64a307fcf --- /dev/null +++ b/src/arrow/r/man/FeatherReader.Rd @@ -0,0 +1,33 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/feather.R +\docType{class} +\name{FeatherReader} +\alias{FeatherReader} +\title{FeatherReader class} +\description{ +This class enables you to interact with Feather files. Create +one to connect to a file or other InputStream, and call \code{Read()} on it to +make an \code{arrow::Table}. See its usage in \code{\link[=read_feather]{read_feather()}}. +} +\section{Factory}{ + + +The \code{FeatherReader$create()} factory method instantiates the object and +takes the following argument: +\itemize{ +\item \code{file} an Arrow file connection object inheriting from \code{RandomAccessFile}. +} +} + +\section{Methods}{ + +\itemize{ +\item \verb{$Read(columns)}: Returns a \code{Table} of the selected columns, a vector of +integer indices +\item \verb{$column_names}: Active binding, returns the column names in the Feather file +\item \verb{$schema}: Active binding, returns the schema of the Feather file +\item \verb{$version}: Active binding, returns \code{1} or \code{2}, according to the Feather +file version +} +} + -- cgit v1.2.3