Generate a TileDBGroup Object — TileDBGroup • R6.tiledb

Base class for representing a TileDB Group.

Initialization

A new TileDBGroup instance is initialized using the new() method:

 # uri path
 uri <- tempdir()
 # new instance
 obj <- TileDBGroup$new(uri = uri)
 # does array exist at this uri
 obj$exists() # FALSE

 unlink(uri)

Value

An object of class TileDBGroup, R6.

Super class

TileDBObject -> TileDBGroup

Active bindings

object

Access the underlying tiledb::tiledb_group() object.

members

Access the list of group members.

If TileDB group object is closed, it will be opened to get members and close on exit.

Methods

Inherited methods

`TileDBGroup$create()`

Create a TileDB Group object at the given URI path.

Usage

TileDBGroup$create(mode = "WRITE")

Arguments

mode: Mode to open : either "READ" or "WRITE" (default).

Returns

The object, invisibly.

`TileDBGroup$open()`

Open TileDB group object in read or write mode.

Usage

TileDBGroup$open(mode = c("READ", "WRITE"))

Arguments

mode: Mode to open : either "READ" or "WRITE". Default is "READ".

Returns

The object, invisibly.

`TileDBGroup$close()`

Close the group object.

All instantiated group members will be closed if opened, and before closing the group object.

Usage

TileDBGroup$close()

Returns

The object, invisibly.

`TileDBGroup$remove()`

Remove member.

Removes an array or group resource from TileDBGroup member list.

Usage

TileDBGroup$remove(name)

Arguments

name: Name of the member to remove.

Returns

The object, invisibly.

`TileDBGroup$delete()`

Delete member.

Deletes a TileDBGroup's member from disk and removes it from member list.

Usage

TileDBGroup$delete(name)

Arguments

name: Name of the member to delete.

Returns

The object, invisibly.

`TileDBGroup$count_members()`

Count the number of members in the group.

Usage

TileDBGroup$count_members()

Returns

The number of members in the group.

`TileDBGroup$get_members_df()`

List group members.

Usage

TileDBGroup$get_members_df(type = c("ALL", "GROUP", "ARRAY"))

Arguments

type: Select type member, either"ALL", "GROUP" or "ARRAY". By default all member types are listed.

Returns

A data.frame with columns name, type, and uri.

`TileDBGroup$get_member()`

Retrieve a group member by name. If the member isn't already open, it is opened in the same mode as the parent.

Usage

TileDBGroup$get_member(name)

Arguments

name: The name of the member.

Returns

A TileDBArray or TileDBGroup.

`TileDBGroup$set_member()`

Add new member to the group.

Usage

TileDBGroup$set_member(object, name = NULL, relative = NULL)

Arguments

object: A TileDBArray or TileDBGroup object to add.
name: Name to use for the member. By default the base name of the object's URI is used.
relative: An optional logical value indicating whether the new object's URI is relative to the group's URI. If NULL (the default), the object's URI is assumed to be relative unless it is a tiledb:// URI.

Returns

The object, invisibly.

`TileDBGroup$names()`

Retrieve the members' names.

Usage

TileDBGroup$names()

Returns

A character vector of member names.

`TileDBGroup$member_exists()`

Check if a member exists.

Usage

TileDBGroup$member_exists(name)

Arguments

name: Name of the member to check.

Returns

A logical value.

`TileDBGroup$print()`

Print summary of the group.

Usage

TileDBGroup$print()

`TileDBGroup$dump()`

Dump the TileDB Group structure to string.

Usage

TileDBGroup$dump(title = "TileDB Directory", recursive = TRUE)

Arguments

title: A character string for title header. Set NULL to omit.
recursive: Should the nested uris be returned recursively? Default is TRUE.

Returns

A character string, invisibly.

`TileDBGroup$clone()`

The objects of this class are cloneable with this method.

Usage

TileDBGroup$clone(deep = FALSE)

Arguments

deep: Whether to make a deep clone.