diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
commit | e6918187568dbd01842d8d1d2c808ce16a894239 (patch) | |
tree | 64f88b554b444a49f656b6c656111a145cbbaa28 /src/arrow/r/man/FeatherReader.Rd | |
parent | Initial commit. (diff) | |
download | ceph-e6918187568dbd01842d8d1d2c808ce16a894239.tar.xz ceph-e6918187568dbd01842d8d1d2c808ce16a894239.zip |
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | src/arrow/r/man/FeatherReader.Rd | 33 |
1 files changed, 33 insertions, 0 deletions
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 +} +} + |