AssayMatrixGroup: Single-cell Assay Matrix Group

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

Single-cell Assay Matrix Group

Description

Class for representing a TileDB group containing one or more AssayMatrix arrays that share the same dimensions.

Super classes

tiledbsc::TileDBObject -> tiledbsc::TileDBGroup -> tiledbsc::AnnotationGroup -> AssayMatrixGroup

Methods

Public methods

• AssayMatrixGroup$add_assay_matrix()

• AssayMatrixGroup$clone()

Inherited methods

• tiledbsc::TileDBObject$class()
• tiledbsc::TileDBObject$exists()
• tiledbsc::TileDBGroup$add_member()
• tiledbsc::TileDBGroup$add_metadata()
• tiledbsc::TileDBGroup$count_members()
• tiledbsc::TileDBGroup$get_member()
• tiledbsc::TileDBGroup$get_members()
• tiledbsc::TileDBGroup$get_metadata()
• tiledbsc::TileDBGroup$group_exists()
• tiledbsc::TileDBGroup$list_member_uris()
• tiledbsc::TileDBGroup$list_members()
• tiledbsc::TileDBGroup$list_object_uris()
• tiledbsc::TileDBGroup$list_objects()
• tiledbsc::TileDBGroup$print()
• tiledbsc::TileDBGroup$remove_member()
• tiledbsc::TileDBGroup$tiledb_group()
• tiledbsc::AnnotationGroup$initialize()
• tiledbsc::AnnotationGroup$reset_query()
• tiledbsc::AnnotationGroup$set_query()

---

Method add_assay_matrix()

Add a new AssayMatrix array to the group.

Usage

AssayMatrixGroup$add_assay_matrix(
  data,
  name,
  value_col = "value",
  metadata = NULL
)

Arguments

data

a matrix of annotation data to ingest. The matrix rows must be aligned to the dimension indicated by the group's dimension_name.

name

Name for the new array, nested with the group's URI.

value_col

Name to use for the TileDB array's attribute that will contain the matrix values.

metadata

Named list of metadata to add.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

AssayMatrixGroup$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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