Skip to content

Latest commit

 

History

History
197 lines (107 loc) · 10 KB

ega.md

File metadata and controls

197 lines (107 loc) · 10 KB

EGA DAC metadata schema Schema

https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.DAC.json

Metadata schema used by the European Genome-phenome Archive (EGA) to validate its Data Access Committee (DAC) metadata object. This object is intended to contain metadata about the body of one or more named individuals or legal entities who are data controllers. In other words, responsible for data release to external requestors based on consent and/or National Research Ethics terms. A DAC is typically formed, but not necessarily, from the same organization that collected the samples and generated any associated files/analyses. 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/submission/data_access_committee)

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Forbidden none EGA.DAC.json

EGA DAC metadata schema Type

object (EGA DAC metadata schema)

EGA DAC metadata schema Properties

Property Type Required Nullable Defined by
objectId Merged Required cannot be null EGA DAC metadata schema
schemaDescriptor object Optional cannot be null EGA DAC metadata schema
objectTitle string Optional cannot be null EGA DAC metadata schema
objectDescription string Optional cannot be null EGA DAC metadata schema
dacContacts object Required cannot be null EGA DAC metadata schema
dacRelationships array Optional cannot be null EGA DAC metadata schema
dacAttributes array Optional cannot be null EGA DAC metadata schema

objectId

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: an DAC (by using EGADACIdPattern)

objectId

objectId Type

object (Object's IDs block)

all of

schemaDescriptor

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

schemaDescriptor Type

object (Schema descriptor)

objectTitle

Short free-form text that can be used to call out DAC records in searches or displays.

objectTitle

objectTitle Type

string (Title of the DAC)

objectTitle Constraints

minimum length: the minimum number of characters for this string is: 1

objectTitle Examples

"EBI Consortium Data Access Committee"

objectDescription

An in-depth description of the DAC, including its overall purpose or nature of studies it governs.

objectDescription

objectDescription Type

string (Description of the DAC)

objectDescription Constraints

minimum length: the minimum number of characters for this string is: 1

objectDescription Examples

"EBI DAC governing data from projects related to human microbiome with data provenance..."

dacContacts

Object containing the main contact's and optional additional contact's details.

dacContacts

dacContacts Type

object (DAC contacts' details)

dacRelationships

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. a policy being linked to a DAC) the EGA.

dacRelationships

dacRelationships Type

an array of merged types (Details)

dacRelationships Constraints

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.

dacAttributes

Custom attributes of a DAC: 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.

dacAttributes

dacAttributes Type

object[] (Custom attribute of an object)

dacAttributes Constraints

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.