R: ChunkedArray class

ChunkedArray {arrow} | R Documentation

## ChunkedArray class

### Description

A `ChunkedArray` is a data structure managing a list of primitive Arrow Arrays logically as one large array. Chunked arrays may be grouped together in a Table.

### Usage

    chunked_array(..., type = NULL)

### Arguments

`...` | Vectors to coerce
`type` | currently ignored

### Factory

The `ChunkedArray$create()` factory method instantiates the object from various Arrays or R vectors. `chunked_array()` is an alias for it.

### Methods

- `$length()`: Size in the number of elements this array contains

- `$chunk(i)`: Extract an `Array` chunk by integer position

- `$as_vector()`: convert to an R vector

- `$Slice(offset, length = NULL)`: Construct a zero-copy slice of the array with the indicated offset and length. If length is `NULL`, the slice goes until the end of the array.

- `$Take(i)`: return a `ChunkedArray` with values 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 a `ChunkedArray` with values at positions where logical vector or Arrow boolean-type `(Chunked)Array` `i` is `TRUE`.

- `$cast(target_type, safe = TRUE, options = cast_options(safe))`: Alter the data in the array to change its type.

- `$null_count()`: The number of null entries in the array

- `$chunks()`: return a list of `Array`s

- `$num_chunks()`: integer number of chunks in the `ChunkedArray`

- `$type()`: logical type of data

- `$View(type)`: Construct a zero-copy view of this `ChunkedArray` with the given type.

- `$Validate()`: Perform any validation checks to determine obvious inconsistencies within the array's internal data. This can be an expensive check, potentially `O(length)`

### See Also

Array

[Package arrow version 1.0.1 Index]