TileDBArray-globals: TileDBArray global options

In LTLA/TileDBArray: Using TileDB as a DelayedArray Backend

TileDBArray global options

Description

Global options for writing TileDBArray backends, intended for parameters that cannot be automatically derived from the data.

Usage

getTileDBPath()

setTileDBPath(path = NULL)

getTileDBAttr()

setTileDBAttr(attr = NULL)

getTileDBDimType()

setTileDBDimType(dimtype = NULL)

getTileDBExtent()

setTileDBExtent(extent = NULL)

getTileDBContext()

setTileDBContext(context = NULL)

getTileDBCellOrder()

setTileDBCellOrder(cellorder = NULL)

getTileDBTileOrder()

setTileDBTileOrder(tileorder = NULL)

getTileDBCapacity()

setTileDBCapacity(capacity = NULL)

Arguments

path	String containing a path to a TileDB backend.
attr	String containing the name of a TileDB attribute.
dimtype	String specifying the TileDB datatype to use for the dimensions.
extent	Integer scalar specifying the tile extent for all dimensions. Alternatively, an integer vector of length equal to the number of dimensions, specifying a different extent for each dimension in the array to be created.
context	A TileDB context object, see tiledb_ctx for an example.
cellorder	String specifying the desired cell order.
tileorder	String specifying the desired tile order.
capacity	Integer scalar specifying the data tile capacity for sparse arrays.

Value

All of the getter functions return the current global value, or a default value if the former is NULL:

• path defaults to a temporary file in tempdir.

• attr defaults to "x".

• dimtype defaults to "INT32".

• extent defaults to 100L.

• cellorder defaults to "COL_MAJOR".

• tileorder defaults to "COL_MAJOR".

• capacity defaults to 10000L.

• context defaults to the value of tiledb_ctx().

All setter functions change the global value and return NULL invisibly.

Author(s)

Aaron Lun

See Also

writeTileDBArray, where these functions are most often used.

Examples

setTileDBPath("my_local_dir")
getTileDBPath()

LTLA/TileDBArray documentation built on Oct. 9, 2024, 7:52 a.m.