tiledbsoma.ExperimentAxisQuery.X

ExperimentAxisQuery.X(layer_name: str, *, batch_size: BatchSize = BatchSize(count=None, bytes=None), partitions: ReadPartitions | None = None, result_order: ResultOrder | Literal['auto', 'row-major', 'column-major'] = ResultOrder.AUTO, platform_config: Dict[str, Mapping[str, Any]] | object | None = None) → SparseRead

Returns an X layer as a sparse read.

Parameters:

• layer_name – The X layer name to return.

• batch_size – The size of batches that should be returned from a read. See BatchSize for details.

• partitions – Specifies that this is part of a partitioned read, and which partition to include, if present.

• result_order – the order to return results, specified as a ResultOrder or its string value.

Lifecycle: maturing