CIMAC-CIDC/cidc-schemas

View on GitHub
cidc_schemas/schemas/assays/microbiome_assay.json

Summary

Maintainability
Test Coverage
{
  "$schema": "metaschema/strict_meta_schema.json#",
  "$id": "microbiome",
  "title": "Microbiome Assay",
  "type": "object",
    
  "$comment": "description used in docs/index.html and docs/assays.microbiome.html",
  "description": "Microbiome Assay.",
  
  "additionalProperties": false,
  "mergeStrategy": "objectMerge",
  
  "required": [
    "records",
    "batch_id",
    "forward_fastq",
    "forward_index",
    "reverse_fastq"
  ],

  "allOf": [
    { "$ref": "assays/components/assay_core.json" },
    { "$ref": "assays/components/ngs_assay_core.json" }
  ],

  "definitions": {
        "entry": {
            "type": "object",
            "mergeStrategy": "objectMerge",
            "description": "A single data record from microbiome assay.",
            "additionalProperties": false,
            "required": [
                "cimac_id",
                "library_yield_ng"
            ],
      "properties": {
        "cimac_id": { "$ref": "assays/components/ngs_assay_record.json#properties/cimac_id" },

        "library_yield_ng": {
          "description": "Resulting yield (in ng) from library construction.",
          "type": ["number", "string"]
        }
      }
        }
    },

  "properties": {
    "assay_creator": { "$ref": "assays/components/assay_core.json#properties/assay_creator" },
    "batch_id": {
      "description": "Microbiome batch identification number.",
      "type": "string"
    },
    "sequencer_platform": { "$ref": "assays/components/ngs_assay_core.json#properties/sequencer_platform" },
    "forward_fastq": {"$ref": "artifacts/artifact_fastq_gz.json"},
    "forward_index": {"$ref": "artifacts/artifact_fastq_gz.json"},
    "reverse_fastq": {"$ref": "artifacts/artifact_fastq_gz.json"},
    "reverse_index": {"$ref": "artifacts/artifact_fastq_gz.json"},
    "otu_table": {"$ref": "artifacts/artifact_tsv.json"},
    "summary_file": {"$ref": "artifacts/artifact_pdf.json"},

    "records": {
      "type": "array",
      "description": "A single data record from microbiome assay.",
      "mergeStrategy": "append",
      
      "items": {
                "$ref": "assays/microbiome_assay.json#definitions/entry"
      }
    }
  }
}