Dataset

Type: object

A dataset containing multiple summarized experiments, possibly with non-trivial relationships between the columns of different experiments. This is derived from Bioconductor's MultiAssayExperiment class. This document contains pointers to the various components including the sample data, sample mapping and experiments.

 No Additional Properties

root $schema
Type: string

The schema to use.

root dataset
Type: object
No Additional Properties

root dataset experiments
Type: array of object

Array of pointers to the summarized experiments. Each experiment should contain column names that are unique within that experiment.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root dataset experiments experiments items
Type: object

root dataset experiments experiments items name
Type: string

Name of the experiment. This should be a non-empty string. Experiment names should also be unique within experiments.

Must be at least 1 characters long

root dataset experiments experiments items resource
Type: object

root dataset experiments experiments items resource path
Type: string

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

root dataset experiments experiments items resource type
Type: enum (of string)

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

Must be one of:

  • "local"

root dataset other_data
Type: object

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

root dataset other_data resource
Type: object

root dataset other_data resource path
Type: string

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

root dataset other_data resource type
Type: enum (of string)

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

Must be one of:

  • "local"

root dataset sample_data
Type: object

Pointer to the sample data. This should be a data frame with one row per sample in the dataset, where each column contains sample annotations. Row names should be present and unique.

root dataset sample_data resource
Type: object

root dataset sample_data resource path
Type: string

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

root dataset sample_data resource type
Type: enum (of string)

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

Must be one of:

  • "local"

root dataset sample_mapping
Type: object

Pointer to the sample mappings. This defines the relationships between columns of the summarized experiments and the samples in the dataset. The data frame should always contain three string columns:

  • sample, the sample name.
  • 'experiment', the name of the experiment.
  • 'column', the name of the column in that experiment.

Each row defines a single relationship between a sample and an experiment's column.

root dataset sample_mapping resource
Type: object

root dataset sample_mapping resource path
Type: string

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

root dataset sample_mapping resource type
Type: enum (of string)

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

Must be one of:

  • "local"

root is_child
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.

root path
Type: string

Path to the file in the project directory.