Bumpy Data Frame Matrix

Type: object

A bumpy matrix of data frames, corresponding to the BumpyDataFrameMatrix class from the BumpyMatrix package. Each entry of the matrix contains a data frame with a variable number of rows but the same columns. A concatenated data frame is created by row-wise combining all individual data frames and is referenced by the concatenated property.

Derived from bumpy_matrix/v1.json: a virtual "bumpy" matrix of vector-like objects of the same type, corresponding to the BumpyMatrix class from the BumpyMatrix package. Each entry of the matrix contains a vector-like object with a variable number of subelements.For efficient storage, all matrix elements are concatenated into a single object of the same type, with length equal to the total number of subelements across all vector-like objects.

To reconstitute the bumpy matrix, we can inspect the partitioning information in the data frame, which is saved to path as a CSV file under the comservatory specification (version 1). Each row of the data frame corresponds to an vector-like object in the bumpy matrix. The columns row, column and number are present in this data frame, specifying the 1-based row index, 1-based column index and length of the vector-like object. Subelements of the concatenated object are partitioned by assigning the specified number of consecutive subelements into a series of contiguous vector-like objects, each of which correspond to successive rows in the data frame.Matrix entries not listed in the data frame are assumed to be length-0 vector-like objects of the same type.

If row or column names are present on the bumpy matrix, they are in separate files.These child objects should be referenced by the bumpy_matrix.row_names and bumpy_matrix.column_names properties.

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

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

root $schema
Type: string

The schema to use.

root array
Type: object
No Additional Properties

root array dimensions
Type: array of integer

Dimensions of an n-dimensional array.

Must contain a minimum of 2 items

Must contain a maximum of 2 items

No Additional Items

Each item of this array must be:

root array dimensions dimensions items
Type: integer

root array type
Type: enum (of string)

Type of data stored in this array.

Must be one of:

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

root bumpy_data_frame_matrix
Type: object
No Additional Properties

root bumpy_data_frame_matrix concatenated
Type: object

Pointer to the row-wise concatenated data frame.

root bumpy_data_frame_matrix concatenated resource
Type: object

root bumpy_data_frame_matrix concatenated resource path
Type: string

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

root bumpy_data_frame_matrix concatenated 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 bumpy_matrix
Type: object
No Additional Properties

root bumpy_matrix column_names
Type: object

Pointer to a string vector containing the column names for the bumpy matrix. This should be of length equal to the number of columns.If omitted, no column names were present.

In minor version 1, this is instead a 1-column data frame where the only column contains the column names.

root bumpy_matrix column_names resource
Type: object

root bumpy_matrix column_names resource path
Type: string

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

root bumpy_matrix column_names 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 bumpy_matrix compression
Type: enum (of string)

Type of compression applied to the file.

Must be one of:

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

root bumpy_matrix object_count
Type: integer

Number of vector-like objects in the bumpy matrix, where each object is represented by a row in the data frame at path. If this is less than the product of the matrix dimensions, it is assumed that the entries missing from the CSV correspond to empty vector-like objects in the bumpy matrix.

Value must be greater or equal to 0

root bumpy_matrix object_names
Type: boolean Default: false

Whether the individual vector-like objects are named. If true, the first column of the CSV is called names and contains the name for the object corresponding to each row. Note that this does not represent the row or column names of the bumpy matrix itself, but instead of the individual (non-empty) vector-like objects.

root bumpy_matrix row_names
Type: object

Pointer to a string vector containing the row names for the bumpy matrix. This should be of length equal to the number of rows.If omitted, no row names were present.

In minor version 1, this is instead a 1-column data frame where the only column contains the row names.

root bumpy_matrix row_names resource
Type: object

root bumpy_matrix row_names resource path
Type: string

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

root bumpy_matrix row_names 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 md5sum
Type: string

MD5 checksum for the file.

root path
Type: string

Path to the file in the project directory.

root version
Type: integer Default: 1

Minor version of this schema.

Value must be lesser or equal to 2