Code Structure

The library consists of three modules, the syntactic check module, the semantic check module, and the object representation module for (de-)serialisation.

Object Representation Overview

digraph inheritancefdd79abd6f { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "json.encoder.JSONEncoder" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Extensible JSON <https://json.org> encoder for Python data structures."]; "mzqc.MZQCFile.AnalysisSoftware" [URL="package.html#mzqc.MZQCFile.AnalysisSoftware",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="AnalysisSoftware Object representation for mzQC schema type AnalysisSoftware"]; "mzqc.MZQCFile.CvParameter" -> "mzqc.MZQCFile.AnalysisSoftware" [arrowsize=0.5,style="setlinewidth(0.5)"]; "mzqc.MZQCFile.BaseQuality" [URL="package.html#mzqc.MZQCFile.BaseQuality",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="BaseQuality Object representation for mzQC schema type BaseQuality"]; "mzqc.MZQCFile.jsonobject" -> "mzqc.MZQCFile.BaseQuality" [arrowsize=0.5,style="setlinewidth(0.5)"]; "mzqc.MZQCFile.ControlledVocabulary" [URL="package.html#mzqc.MZQCFile.ControlledVocabulary",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="ControlledVocabulary Object representation for mzQC schema type ControlledVocabulary"]; "mzqc.MZQCFile.jsonobject" -> "mzqc.MZQCFile.ControlledVocabulary" [arrowsize=0.5,style="setlinewidth(0.5)"]; "mzqc.MZQCFile.CvParameter" [URL="package.html#mzqc.MZQCFile.CvParameter",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="CvParameter Object representation for mzQC schema type CvParameter"]; "mzqc.MZQCFile.jsonobject" -> "mzqc.MZQCFile.CvParameter" [arrowsize=0.5,style="setlinewidth(0.5)"]; "mzqc.MZQCFile.InputFile" [URL="package.html#mzqc.MZQCFile.InputFile",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="InputFile Object representation for mzQC schema type InputFile"]; "mzqc.MZQCFile.jsonobject" -> "mzqc.MZQCFile.InputFile" [arrowsize=0.5,style="setlinewidth(0.5)"]; "mzqc.MZQCFile.JsonSerialisable" [URL="package.html#mzqc.MZQCFile.JsonSerialisable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="JsonSerialisable Main structure template for mzQC objects"]; "mzqc.MZQCFile.MetaDataParameters" [URL="package.html#mzqc.MZQCFile.MetaDataParameters",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="MetaDataParameters Object representation for mzQC schema type MetaDataParameters"]; "mzqc.MZQCFile.jsonobject" -> "mzqc.MZQCFile.MetaDataParameters" [arrowsize=0.5,style="setlinewidth(0.5)"]; "mzqc.MZQCFile.MzQcFile" [URL="package.html#mzqc.MZQCFile.MzQcFile",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="MzQcFile Object representation for mzQC schema type MzQcFile"]; "mzqc.MZQCFile.jsonobject" -> "mzqc.MZQCFile.MzQcFile" [arrowsize=0.5,style="setlinewidth(0.5)"]; "mzqc.MZQCFile.MzqcJSONEncoder" [URL="package.html#mzqc.MZQCFile.MzqcJSONEncoder",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="MzqcJSONEncoder The encoder used to facilitate indented encoding "]; "json.encoder.JSONEncoder" -> "mzqc.MZQCFile.MzqcJSONEncoder" [arrowsize=0.5,style="setlinewidth(0.5)"]; "mzqc.MZQCFile.QualityMetric" [URL="package.html#mzqc.MZQCFile.QualityMetric",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="QualityMetric Object representation is passed for its more concrete derivatives"]; "mzqc.MZQCFile.CvParameter" -> "mzqc.MZQCFile.QualityMetric" [arrowsize=0.5,style="setlinewidth(0.5)"]; "mzqc.MZQCFile.RunQuality" [URL="package.html#mzqc.MZQCFile.RunQuality",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="QualityMetric Object representation is passed for its more general basis"]; "mzqc.MZQCFile.BaseQuality" -> "mzqc.MZQCFile.RunQuality" [arrowsize=0.5,style="setlinewidth(0.5)"]; "mzqc.MZQCFile.SetQuality" [URL="package.html#mzqc.MZQCFile.SetQuality",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="SetQuality Object representation is passed for its more general basis"]; "mzqc.MZQCFile.BaseQuality" -> "mzqc.MZQCFile.SetQuality" [arrowsize=0.5,style="setlinewidth(0.5)"]; "mzqc.MZQCFile.jsonobject" [URL="package.html#mzqc.MZQCFile.jsonobject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="jsonobject Proxy object for better integration of mzQC objects"]; }