Amalgamated array

Type: object

An amalgam of multiple arrays, combined into a single object for downstream use. This is typically used to combine data from different samples or conditions into a single array, e.g., to store in a consolidated SummarizedExperiment object. The key feature of this schema is that the individual component matrices are still represented by separate files; this means that it can be very cheap to add or remove components by just modifying the metadata rather than making a new copy of the entire combined array.

Derived from array/v1.json: some kind of multi-dimensional array, where we store metadata about the dimensions and type of data. The exact implementation of the array is left to concrete subclasses.

No Additional Properties

Type: string

The schema to use.

Type: object
No Additional Properties

Type: integer

Index of the dimension on which the various component arrays are combined. This should be a non-negative value that is less than the length of array.dimensions. For matrices, a value of 0 indicates that the arrays are combined by row, while a value of 1 indicates a combination by column.

Value must be greater or equal to 0

Type: array of object

Components of the amalgamated array. Each component should be an array of the same dimensionality, with the same extents for all dimensions other than extent. The amalgamated array is formed by combining the component arrays in the order listed here; the sum of extents of dimension along across components should be equal to the corresponding entry of array.dimensions.

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

Name of the component. Typically used to specify the sample or condition of origin.

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 integer

Dimensions of an n-dimensional array.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: integer

Type: enum (of string)

Type of data stored in this array.

Must be one of:

  • "boolean"
  • "number"
  • "integer"
  • "string"
  • "other"

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.