TileDBArray-globals: TileDBArray global options

In TileDBArray: Using TileDB as a DelayedArray Backend

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)

getTileDBExtent()

setTileDBExtent(extent = NULL)

getTileDBContext()

setTileDBContext(context = NULL)

Arguments

path	String containing a path to a TileDB backend.
attr	String containing the name of a TileDB attribute.
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.

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".

• extent defaults to 100L.

• 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()

TileDBArray documentation built on Nov. 8, 2020, 6:38 p.m.