Atomic Vector List

Type: object

A compressed list of atomic vectors of the same type. The concatenation of all vectors is stored in the resource referenced by the concatenated property.

Derived from compressed_list/v1.json: a virtual compressed list where all elements are vector-like objects of the same type, corresponding to the CompressedList class from the IRanges Bioconductor package. Each list element contains a vector-like object with a variable number of subelements, which can be concatenated into a single vector-like object of the same type with length equal to the sum of the individual element lengths.The use of a concatenated object improves storage efficiency as list elements can be compressed into a single file.

The partitioning of the concatenated object into individual list elements is described in a data frame, saved to path as a CSV file; see here for a detailed specification. This data frame contains one row per list element and has a number column that specifies the size of each vector-like object. Subelements are partitioned by assigning the specified number of consecutive subelements into a contiguous series of vector-like objects, each of which correspond to successive list elements.If the names property is true, number should be the second column, where the first column of the data frame contains the names of the list elements.

Concrete subclasses are expected to provide a concatenated property that points to the concatenated object.

No Additional Properties

Type: string

The schema to use.

Type: object
No Additional Properties

Type: object

Pointer to the concatenated contents of all the atomic vectors. This is stored as a 1-column data frame. If the data frame has row names, these are used as the names of the elements of the concatenated vector.

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: enum (of string)

Type of compression applied to the file.

Must be one of:

  • "none"
  • "gzip"
  • "bzip2"

Type: object

Pointer to a data frame containing additional annotations for each element in the list. If omitted, no additional annotations are 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: integer

Number of entries, specifically the number of groups.

Type: boolean Default: false

Whether the list is named. If true, the first column of CSV contains the names of the list elements.

Type: object

Pointer to a list containing additional metadata for this object. Omitted if no additional metadata is available.

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: 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

MD5 checksum for the file.

Type: string

Path to the file in the project directory.