https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.study.jsonMetadata schema used by the European Genome-phenome Archive (EGA) to validate its Study metadata object. This object is intended to contain metadata about the compilation of examinations, analyses or critical inspection of a particular subject. In other words, a Study is a container of experiments and analyses of any nature (including Array data) grouped by a common goal or investigation. They often draw together data from a range of datasets and are represented in publication. For instance, an example would be a case-control study on cancer patients and healthy individuals. Further details can be found in the EGA-metadata-schema GitHub repository (https://github.com/EbiEga/ega-metadata-schema/tree/main/schemas) and EGA-archive website (https://ega-archive.org/studies)
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | EGA.study.json |
object (EGA study metadata schema)
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| objectId | Merged | Required | cannot be null | EGA study metadata schema |
| schemaDescriptor | object |
Optional | cannot be null | EGA study metadata schema |
| objectTitle | string |
Required | cannot be null | EGA study metadata schema |
| objectDescription | string |
Optional | cannot be null | EGA study metadata schema |
| studyTypes | array |
Required | cannot be null | EGA study metadata schema |
| studyDesigns | array |
Required | cannot be null | EGA study metadata schema |
| studyRelationships | array |
Optional | cannot be null | EGA study metadata schema |
| studyAttributes | array |
Optional | cannot be null | EGA study metadata schema |
Node containing the main identifiers of the object (e.g. alias, centerName...), inherited from the common definitions. #! We extend the core object (objectCoreId) by adding a pattern check based on this schema's nature: a study (by using EGAStudyIdPattern)
objectId
-
is required
-
Type:
object(Object's IDs block) -
cannot be null
-
defined in: EGA study metadata schema
object (Object's IDs block)
all of
-
any of
This node is intended to be used to describe the schemas and standards that a JSON document was based on. For instance, if a sample.json document was created to be validated against EGA.sample.json schema version 1.0.0, such information should be reflected in this block. This way, both a human and a machine can interpret and validate the JSON document efficiently, without the need of guessing versions.
schemaDescriptor
-
is optional
-
Type:
object(Schema descriptor) -
cannot be null
-
defined in: EGA study metadata schema
object (Schema descriptor)
Short free-form text that can be used to call out study records in searches or displays.
objectTitle
-
is required
-
Type:
string(Title of the study) -
cannot be null
-
defined in: EGA study metadata schema
string (Title of the study)
"EBI test case-control study for cancer"An in-depth description of the study, including its overall purpose, goals, scope or nature.
objectDescription
-
is optional
-
Type:
string(Description of the study) -
cannot be null
-
defined in: EGA study metadata schema
string (Description of the study)
"EBI genome-wide case-control association study for Hypertension (HT) using seven disease collections together with the 1958 Spanish Birth Cohort and the EU National Blood Service collections as controls."List of study types. Contains specific keywords (e.g. 'COVID-19') as items that can be associated to the study, providing an overall view of its purpose.
studyTypes
-
is required
-
Type:
string[](Study type) -
cannot be null
-
defined in: EGA study metadata schema
string[] (Study type)
minimum number of items: the minimum number of items for this array is: 1
unique items: all items in this array must be unique. Duplicates are not allowed.
List of study designs (a.k.a. experimental designs). Contains specific keywords (e.g. 'RNA stability design') as items that can be associated to the study, providing an overall view of the method of investigating particular types of research questions or solving particular types of problems.
studyDesigns
-
is required
-
Type:
string[](Enumeration of design keywords) -
cannot be null
-
defined in: EGA study metadata schema
string[] (Enumeration of design keywords)
minimum number of items: the minimum number of items for this array is: 1
unique items: all items in this array must be unique. Duplicates are not allowed.
Comprises metadata (e.g. Source or Target) of a directional association between two entities. This relationships node contains all the possible relationships between metadata objects, both outside of (e.g. an Array Design Format that was submitted to ArrayExpress being linked to their microarray data within EGA) and within (e.g. an ArrayExperiment being linked to a study) the EGA.
studyRelationships
-
is optional
-
Type: an array of merged types (Details)
-
cannot be null
-
defined in: EGA study metadata schema
an array of merged types (Details)
minimum number of items: the minimum number of items for this array is: 1
unique items: all items in this array must be unique. Duplicates are not allowed.
Custom attributes of a study: reusable attributes to encode tag-value pairs (e.g. Tag being 'Targeted loci' and its Value '5:63256183-63258334') with optional units (e.g. 'base pairs'). Its properties are inherited from the common-definitions.json schema.
studyAttributes
-
is optional
-
Type:
object[](Custom attribute of an object) -
cannot be null
-
defined in: EGA study metadata schema
object[] (Custom attribute of an object)
minimum number of items: the minimum number of items for this array is: 1
unique items: all items in this array must be unique. Duplicates are not allowed.