Skip to content

Commit

Permalink
add schema
Browse files Browse the repository at this point in the history
  • Loading branch information
mrJeppard committed Jun 7, 2019
1 parent 246ec12 commit 6630e7a
Showing 1 changed file with 108 additions and 0 deletions.
108 changes: 108 additions & 0 deletions cluster_solution_schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://hexcalc.ucsc.edu:9000/",
"description": "Relevant metadata for a cluster solution executed on single cell mRNA seq data.",
"type": "object",
"additionalProperties": false,
"required": [
"name",
"clusters"
],
"properties": {
"name": {
"description": "Name of the cluster solution given by the analyst.",
"type": "string"
},
"method": {
"description": "Name of the method used to create cluster solution given by the analyst.",
"type": "string"
},
"method_url": {
"description": "Url to documentation of the method used to create cluster solution.",
"type": "string"
},
"analyst": {
"description": "User name attached to cluster solution submission.",
"type": "string"
},
"dataset_id": {
"description": "Dataset identifier.",
"type": "string"
},
"na_count": {
"description": "The number of cells that are contained in the dataset but not assigned to a cluster.",
"type": "number"
},
"clusters": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"cell_count",
"cells"
],
"properties": {
"label": {
"description": "The label used to identify a cluster.",
"type": "string"
},
"cell_count": {
"description": "The number of cells in the cluster.",
"type": "number"
},
"cells": {
"description": "Cells belonging to the cluster.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"markers": {
"description": "Cells belonging to the cluster.",
"type": "array",
"items": {
"type": "object",
"required": [
"symbol",
"metrics",
"values"
],
"properties": {
"symbol": {
"type": "string",
"description": "Hugo gene identifier."
},
"metrics": {
"type": "array",
"minItems": 1,
"items": {
"type": "string"
},
"description": "Names of the metrics calculated for the gene marker, parallel with the values array."
},
"values": {
"type": "array",
"minItems": 1,
"items": {
"type": "number"
},
"description": "Values of the metrics calculated for the gene marker, parallel with the metrics array."
}
}
}
}
}
}
}
}
}

0 comments on commit 6630e7a

Please sign in to comment.