SOMA Array Base Class

SOMA Array Base Class

SOMA Array Base Class

Details

Adds SOMA-specific functionality to the TileDBArray class. (lifecycle: maturing)

Super classes

tiledbsoma::TileDBObject -> tiledbsoma::TileDBArray -> SOMAArrayBase

Active bindings

soma_type

Retrieve the SOMA object type.

Methods

Public methods

• SOMAArrayBase$allows_duplicates()

• SOMAArrayBase$attributes()

• SOMAArrayBase$is_sparse()

• SOMAArrayBase$clone()

Inherited methods

• tiledbsoma::TileDBObject$class()
• tiledbsoma::TileDBObject$exists()
• tiledbsoma::TileDBObject$initialize()
• tiledbsoma::TileDBObject$is_open()
• tiledbsoma::TileDBObject$mode()
• tiledbsoma::TileDBObject$reopen()
• tiledbsoma::TileDBArray$attrnames()
• tiledbsoma::TileDBArray$close()
• tiledbsoma::TileDBArray$colnames()
• tiledbsoma::TileDBArray$dimensions()
• tiledbsoma::TileDBArray$dimnames()
• tiledbsoma::TileDBArray$get_metadata()
• tiledbsoma::TileDBArray$index_column_names()
• tiledbsoma::TileDBArray$maxshape()
• tiledbsoma::TileDBArray$ndim()
• tiledbsoma::TileDBArray$non_empty_domain()
• tiledbsoma::TileDBArray$open()
• tiledbsoma::TileDBArray$print()
• tiledbsoma::TileDBArray$schema()
• tiledbsoma::TileDBArray$set_metadata()
• tiledbsoma::TileDBArray$shape()
• tiledbsoma::TileDBArray$tiledb_array()
• tiledbsoma::TileDBArray$tiledb_schema()

---

Method allows_duplicates()

Does an array allow duplicates?

Usage

SOMAArrayBase$allows_duplicates()

Returns

TRUE if the underlying TileDB array allows duplicates; otherwise FALSE

---

Method attributes()

Retrieve the array attributes

Usage

SOMAArrayBase$attributes()

Returns

A named list of array attributes; each entry contains the following named entries:

• “name”: name of the attribute

• “type”: datatype of the attribute

• “ncells”: number of values per dimension cell

• “nullable”: is the attribute nullable

• “filter_list”: a list with filter information; this list contains the following entries:

  • “filter_type”

  • “compression_level”

  • “bit_width”

  • “positive_delta”

  • “float_bytewidth”

  • “float_factor”

  • “float_offset”

---

Method is_sparse()

Is an array sparse?

Usage

SOMAArrayBase$is_sparse()

Returns

TRUE if the underlying TileDB array is sparse; otherwise FALSE

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SOMAArrayBase$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.