Table-class: Table class
In arrow: Integration to 'Apache' 'Arrow'
Table R Documentation
Table class
Description
A Table is a sequence of chunked arrays. They
have a similar interface to record batches, but they can be
composed from multiple record batches or chunked arrays.
S3 Methods and Usage
Tables are data-frame-like, and many methods you expect to work on
a data.frame are implemented for Table. This includes [, [[,
$, names, dim, nrow, ncol, head, and tail. You can also pull
the data from an Arrow table into R with as.data.frame(). See the
examples.
A caveat about the $ method: because Table is an R6 object,
$ is also used to access the object's methods (see below). Methods take
precedence over the table's columns. So, tab$Slice would return the
"Slice" method function even if there were a column in the table called
"Slice".
R6 Methods
In addition to the more R-friendly S3 methods, a Table object has
the following R6 methods that map onto the underlying C++ methods:
-
$column(i): Extract a ChunkedArray by integer position from the table
-
$ColumnNames(): Get all column names (called by names(tab))
-
$nbytes(): Total number of bytes consumed by the elements of the table
-
$RenameColumns(value): Set all column names (called by names(tab) <- value)
-
$GetColumnByName(name): Extract a ChunkedArray by string name
-
$field(i): Extract a Field from the table schema by integer position
-
$SelectColumns(indices): Return new Table with specified columns, expressed as 0-based integers.
-
$Slice(offset, length = NULL): Create a zero-copy view starting at the
indicated integer offset and going for the given length, or to the end
of the table if NULL, the default.
-
$Take(i): return an Table with rows at positions given by
integers i. If i is an Arrow Array or ChunkedArray, it will be
coerced to an R vector before taking.
-
$Filter(i, keep_na = TRUE): return an Table with rows at positions where logical
vector or Arrow boolean-type (Chunked)Array i is TRUE.
-
$SortIndices(names, descending = FALSE): return an Array of integer row
positions that can be used to rearrange the Table in ascending or descending
order by the first named column, breaking ties with further named columns.
descending can be a logical vector of length one or of the same length as
names.
-
$serialize(output_stream, ...): Write the table to the given
OutputStream
-
$cast(target_schema, safe = TRUE, options = cast_options(safe)): Alter
the schema of the record batch.
There are also some active bindings:
-
$num_columns
-
$num_rows
-
$schema
-
$metadata: Returns the key-value metadata of the Schema as a named list.
Modify or replace by assigning in (tab$metadata <- new_metadata).
All list elements are coerced to string. See schema() for more information.
-
$columns: Returns a list of ChunkedArrays
arrow documentation built on Sept. 11, 2024, 8:02 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| Table | R Documentation |
Table class
Description
A Table is a sequence of chunked arrays. They have a similar interface to record batches, but they can be composed from multiple record batches or chunked arrays.
S3 Methods and Usage
Tables are data-frame-like, and many methods you expect to work on
a data.frame are implemented for Table. This includes [, [[,
$, names, dim, nrow, ncol, head, and tail. You can also pull
the data from an Arrow table into R with as.data.frame(). See the
examples.
A caveat about the $ method: because Table is an R6 object,
$ is also used to access the object's methods (see below). Methods take
precedence over the table's columns. So, tab$Slice would return the
"Slice" method function even if there were a column in the table called
"Slice".
R6 Methods
In addition to the more R-friendly S3 methods, a Table object has
the following R6 methods that map onto the underlying C++ methods:
-
$column(i): Extract aChunkedArrayby integer position from the table -
$ColumnNames(): Get all column names (called bynames(tab)) -
$nbytes(): Total number of bytes consumed by the elements of the table -
$RenameColumns(value): Set all column names (called bynames(tab) <- value) -
$GetColumnByName(name): Extract aChunkedArrayby string name -
$field(i): Extract aFieldfrom the table schema by integer position -
$SelectColumns(indices): Return newTablewith specified columns, expressed as 0-based integers. -
$Slice(offset, length = NULL): Create a zero-copy view starting at the indicated integer offset and going for the given length, or to the end of the table ifNULL, the default. -
$Take(i): return anTablewith rows at positions given by integersi. Ifiis an ArrowArrayorChunkedArray, it will be coerced to an R vector before taking. -
$Filter(i, keep_na = TRUE): return anTablewith rows at positions where logical vector or Arrow boolean-type(Chunked)ArrayiisTRUE. -
$SortIndices(names, descending = FALSE): return anArrayof integer row positions that can be used to rearrange theTablein ascending or descending order by the first named column, breaking ties with further named columns.descendingcan be a logical vector of length one or of the same length asnames. -
$serialize(output_stream, ...): Write the table to the given OutputStream -
$cast(target_schema, safe = TRUE, options = cast_options(safe)): Alter the schema of the record batch.
There are also some active bindings:
-
$num_columns -
$num_rows -
$schema -
$metadata: Returns the key-value metadata of theSchemaas a named list. Modify or replace by assigning in (tab$metadata <- new_metadata). All list elements are coerced to string. Seeschema()for more information. -
$columns: Returns a list ofChunkedArrays
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.