SOMA Blockwise Read Iterator for Arrow Tables

Class that allows for blockwise read iteration of SOMA reads as Arrow Tables.

Super classes

tiledbsoma::ReadIter -> tiledbsoma::BlockwiseReadIterBase -> BlockwiseTableReadIter

Methods

Public methods

• BlockwiseTableReadIter$concat()

• BlockwiseTableReadIter$clone()

Inherited methods

• tiledbsoma::BlockwiseReadIterBase$initialize()
• tiledbsoma::BlockwiseReadIterBase$read_complete()
• tiledbsoma::BlockwiseReadIterBase$read_next()

---

Method concat()

Concatenate the remainder of the blockwise iterator.

Usage

BlockwiseTableReadIter$concat()

Returns

An Arrow Table with the remainder of the iterator.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

BlockwiseTableReadIter$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

dir <- withr::local_tempfile(pattern = "blockwise-table")
dir.create(dir, recursive = TRUE)
(exp <- load_dataset("soma-exp-pbmc-small", dir))
#> <SOMAExperiment>
#>   uri: /tmp/RtmpjD0Pq2/blockwise-table27091038a069/soma-exp-pbmc-small
qry <- exp$axis_query("RNA")
xqry <- qry$X("data")

iter <- xqry$blockwise(0L, size = 20L, reindex_disable_on_axis = TRUE)$tables()
stopifnot(inherits(iter, "BlockwiseTableReadIter"))

while (!iter$read_complete()) {
  block <- iter$read_next()
}