Skip to end of banner
Go to start of banner

Synapse Annotations Schemas

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

This page describes how the DCC manages the content used to annotate files (keys, definitions, and ontological references). Sage Bionetworks has derived standards for how content is annotated Synapse. The latest approved Synapse Annotations are available in a searchable Table of Annotations.

The synapseAnnotations Github repo includes schemas for individual terms. The terms are organized by modules in the terms/ folder. There are subfolders for each module, and the term names include the module. The mechanisms that manage and implement these annotations are described in the README.

Annotation schemas in JSON

Templates for adding new terms are included in the term-templates/ directory. Each individual term is stored in its own JSON mini schema. This is a valid JSON Schema, such as the following:

{   $schema": "<http://json-schema.org/draft-07/schema#",>
    "$id": "<https://repo-prod.prod.sagebase.org/repo/v1/schema/type/registered/sage.annotations-experimentalData.specimenID-0.0.1",>
    "description": "Identifying string linked to a particular sample or specimen",
    "type": "string"
}

Schema editing procedure

  1. Create Github issue if needed in https://github.com/Sage-Bionetworks/synapseAnnotations/issues

  2. Term information is stored in JSON schemas in the synapseAnnotations/terms directory.
    NOTE: Terms specific to MODEL-AD are stored in: synapseAnnotations/terms/neuro

  3. Create a JSON schema file or edit an existing one.

  4. Copy and Paste schema template.

  5. Edit $id line with Modulename and Key name.

  6. Version numbers start with 0.0.1 and should be incremented with each update.

  7. Add new term, a brief definition, and an ontology citation for the included definition.

  8. Create a branch name formatted like ‘username-edit-type/‘

  9. Add a brief description of changes to commit

  10. Data checks will start to run in the background. All data checks must successfully pass.

  11. Once desired changes are committed, initiate a Pull Request and select DCC curators as reviewers.

  12. Once the changes have been merged into master, need to run script to update the metadata dictionary with the latest version of terms. To register these schemas in Synapse run the register-schemas.R script.

Ontology Lookup Service: https://www.ebi.ac.uk/ols/index

AMP-AD Validation (dccvalidator + dccmonitor data)

  • No labels