Single Cell Experiment

Type: object

A single cell experiment where each row corresponds to a feature and each column corresponds to a single cell. This file contains pointers to single-cell-specific components including reduced dimension results and alternative experiments.

Derived from summarized_experiment/v1.json: a summarized experiment where each row corresponds to a feature and each column corresponds to an experimental sample. The layout of this data structure is based on Bioconductor's SummarizedExperiment class. This metadata document contains pointers to the various components of the summarized experiment, including the row data, column data and assays.

No Additional Properties

Type: string

The schema to use.

Type: boolean Default: false

Is this a child document, only to be interpreted in the context of the parent document from which it is linked? This may have implications for search and metadata requirements.

Type: string

Path to the file in the project directory.

Type: object
No Additional Properties

Type: array of object

Array of pointers to alternative experiments. Each file should follow the summarized_experiment schema with number of columns equal to the number of columns in this single cell experiment object.

No Additional Items

Each item of this array must be:

Type: object

Type: string

Name of the alternative experiment. Each alternative experiment should have a non-empty name. Names should be unique across all alternative_experiments.

Must be at least 1 characters long


Examples:

"CITE-seq"
"spike-ins"
"HTO"

Type: object

Type: string

Relative path of the resource from the root of the project directory.

Type: enum (of string)

Type of file. Local files should be present in the same project directory.

Must be one of:

  • "local"

Type: string

Name of the main experiment. This should be different from any value in alternative_experiments.name. If omitted, the main experiment is unnamed; if a name is necessary, users are advised to represent the main experiment with an empty string, as this is guaranteed to avoid overlaps with any value in alternative_experiments.name.


Example:

"RNA-seq"

Type: array of object

Array of pointers to the reduced dimension results. Each entry is expected to follow the array schema, with number of rows equal to the number of columns of the single cell experiment.

No Additional Items

Each item of this array must be:

Type: object

Type: string

Name of the reduced dimensions. Each reduced dimension result should have a non-empty name. Names should be unique across reduced_dimensions.

Must be at least 1 characters long


Examples:

"PCA"
"TSNE"
"UMAP"

Type: object

Type: string

Relative path of the resource from the root of the project directory.

Type: enum (of string)

Type of file. Local files should be present in the same project directory.

Must be one of:

  • "local"

Type: object

Type: string

Relative path of the resource from the root of the project directory.

Type: enum (of string)

Type of file. Local files should be present in the same project directory.

Must be one of:

  • "local"

Type: object
No Additional Properties

Type: array of object

An array of pointers to the assay data. Each entry corresponds to a single assay in the summarized experiment object.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object

Type: string

Name of the assay. Each assay must have a non-empty name. Assay names should not be duplicated within assays.

Must be at least 1 characters long

Type: object

Type: string

Relative path of the resource from the root of the project directory.

Type: enum (of string)

Type of file. Local files should be present in the same project directory.

Must be one of:

  • "local"

Type: object

Pointer to the column data. This should be data frame (as defined by the data_frame schema) where each row corresponds to a column of the summarized experiment and each column contains some annotation for the experimental samples. Omitted if no sample-level annotation is present.

Type: object

Type: string

Relative path of the resource from the root of the project directory.

Type: enum (of string)

Type of file. Local files should be present in the same project directory.

Must be one of:

  • "local"

Type: array of integer

Dimensions of a two-dimensional object.

Must contain a minimum of 2 items

Must contain a maximum of 2 items

No Additional Items

Each item of this array must be:

Type: object

Pointer to the additional metadata for this object, typically stored as a list (via the basic_list schema). Omitted if no additional metadata is present.

Type: object

Type: string

Relative path of the resource from the root of the project directory.

Type: enum (of string)

Type of file. Local files should be present in the same project directory.

Must be one of:

  • "local"

Type: object

Pointer to the row data. This should be data frame (as defined by the data_frame schema) where each row corresponds to a row of the summarized experiment and each column contains some annotation for the features. Omitted if no feature-level annotation is present.

Type: object

Type: string

Relative path of the resource from the root of the project directory.

Type: enum (of string)

Type of file. Local files should be present in the same project directory.

Must be one of:

  • "local"

Type: object

Pointer to the genomic coordinates corresponding to the rows. This should comply with the genomic_ranges or genomic_ranges_list schemas, where each range or group defines the genomic location of the feature corresponding to a row of the summarized experiment. Omitted if no genomic coordinates are present. This is based on Bioconductor's RangedSummarizedExperiment class.

Type: object

Type: string

Relative path of the resource from the root of the project directory.

Type: enum (of string)

Type of file. Local files should be present in the same project directory.

Must be one of:

  • "local"