TileDBObject: TileDB Object Base Class

In TileDB-Inc/tiledbsc: TileDB Single Cell SOMA API

TileDB Object Base Class

Description

Base class to implement shared functionality across the TileDBArray and TileDBGroup classes.

Public fields

verbose

Whether to print verbose output

config

optional configuration

ctx

optional tiledb context

Active bindings

uri

The URI of the TileDB object.

object

Access the underlying TileB object directly (either a tiledb::tiledb_array or tiledb::tiledb_group).

Methods

Public methods

• TileDBObject$new()

• TileDBObject$class()

• TileDBObject$print()

• TileDBObject$exists()

• TileDBObject$clone()

---

Method new()

Create a new TileDB object.

Usage

TileDBObject$new(uri, verbose = TRUE, config = NULL, ctx = NULL)

Arguments

uri

URI for the TileDB object

verbose

Print status messages

config

optional configuration

ctx

optional TileDB context

---

Method class()

Print the name of the R6 class.

Usage

TileDBObject$class()

---

Method print()

Print summary of the array.

Usage

TileDBObject$print()

---

Method exists()

Check if the object exists.

Usage

TileDBObject$exists()

Returns

⁠TRUE`` if the object exists, ⁠FALSE' otherwise.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

TileDBObject$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

TileDB-Inc/tiledbsc documentation built on Aug. 26, 2023, 2:32 p.m.