Skip to content

TableInfo: collection.tsv

abradyIGS edited this page Apr 15, 2022 · 28 revisions

The C2M2 collection entity is a generalization of "dataset" -- a named grouping of files, biosamples and/or subjects.

Defining collections is optional. The collection.tsv table will have one row for each collection you define for your program.

Please see the technical documentation for a complete treatment of how C2M2 collections are used.

Field Field Description Required? Field Value Type Extra Info
id_namespace A CFDE-cleared identifier representing the top-level data space containing this collection [part 1 of 2-component composite primary key] Required string id_namespace is a unique URI prefix pre-registered with CFDE and attached to your program (or a subset of your program) that identifies anything labeled with it as belonging to you. Please see the technical documentation for a full discussion of how this information is built and used.
local_id An identifier representing this collection, unique within this id_namespace [part 2 of 2-component composite primary key] Required string The string formed by concatenating the id_namespace and local_id field values must be unique for each row in this table. Please see the technical documentation for a full discussion of how this information is to be used.
persistent_id A persistent, resolvable (not necessarily retrievable) URI or compact ID permanently attached to this collection Optional string Meant to serve as a permanent address to which landing pages (which summarize metadata associated with this collection) and other relevant annotations and functions can optionally be attached. Please see the technical documentation for a full discussion of how this information is to be used.
creation_time An ISO 8601 -; RFC 3339 (subset)-compliant timestamp documenting this collection's creation time Optional (string) YYYY-MM-DDTHH:MM:SS±NN:NN Examples:
2021-01-08T00:00:00-00:00 ("Jan 8, 2021")
2021-00-00T00:00:00-00:00 ("2021")
2021-01-08T00:45:40-04:00 ("Jan 8, 2021, 12:45:40AM, Zulu minus 4")
Please see the technical documentation for a complete treatment.
abbreviation A very short display label for this collection Optional string Should not exceed 10 characters; can only contain 0-9, a-z, A-Z and underscore ("_").
name A short, human-readable, machine-read-friendly label for this collection Optional string If specified, must be unique to each collection.
description A human-readable description of this collection Optional string
has_time_series_data Does this collection contain time-series data? Optional string allowed values:
true, false, null
 
true == yes, contains time-series data
 
false == no, doesn't contain time-series data
 
null == no info provided
 
Note: 'null' here means
 
no value provided in the TSV: a zero-length string
 
not
 
the four-character string "null"
Clone this wiki locally