AnnotationDataframe: Single-cell Annotation Data Frame

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

Single-cell Annotation Data Frame

Description

Single-cell Annotation Data Frame

Single-cell Annotation Data Frame

Details

Base class for data frames with rows aligned to the observations or features of a SOMA. Used to store a heterogeneous collection of annotations/measurements.

Super classes

tiledbsc::TileDBObject -> tiledbsc::TileDBArray -> tiledbsc::AnnotationArray -> AnnotationDataframe

Public fields

verbose

Print status messages

Methods

Public methods

• AnnotationDataframe$ids()

• AnnotationDataframe$from_dataframe()

• AnnotationDataframe$to_dataframe()

• AnnotationDataframe$clone()

Inherited methods

• tiledbsc::TileDBObject$class()
• tiledbsc::TileDBObject$exists()
• tiledbsc::TileDBArray$add_metadata()
• tiledbsc::TileDBArray$array_exists()
• tiledbsc::TileDBArray$attributes()
• tiledbsc::TileDBArray$attrnames()
• tiledbsc::TileDBArray$dimensions()
• tiledbsc::TileDBArray$dimnames()
• tiledbsc::TileDBArray$fragment_count()
• tiledbsc::TileDBArray$get_metadata()
• tiledbsc::TileDBArray$initialize()
• tiledbsc::TileDBArray$print()
• tiledbsc::TileDBArray$reset_query()
• tiledbsc::TileDBArray$schema()
• tiledbsc::TileDBArray$set_query()
• tiledbsc::TileDBArray$tiledb_array()

---

Method ids()

Retrieves the values from the array's dimension.

Usage

AnnotationDataframe$ids()

---

Method from_dataframe()

Ingest annotation data

Usage

AnnotationDataframe$from_dataframe(x, index_col)

Arguments

x

a data.frame

index_col

Name to use for the TileDB array's dimension that will contain the data.frame row names.

---

Method to_dataframe()

Retrieve the annotation data from TileDB

Usage

AnnotationDataframe$to_dataframe(attrs = NULL)

Arguments

attrs

A character vector of the attribute names to retrieve. By default, all attributes are retrieved.

Returns

A data.frame with row names containing values from the index dimension

---

Method clone()

The objects of this class are cloneable with this method.

Usage

AnnotationDataframe$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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