QualityMetric
Summary of SMaHT Portal object type QualityMetric . Its derived types are: ExternalQualityMetric. Types referencing this type are: AlignedReads, File, HistologyImage, OutputFile, ReferenceFile, SubmittedFile, SupplementaryFile, UnalignedReads, VariantCalls. Property names in red are required properties; those in blue are identifying properties; and properties with types in green are reference properties.Description: Schema for quality control data for a file.
Tip
See actual QualityMetric data hereRequired Properties
| Property | Type | Description |
|---|---|---|
| qc_values | array of object | See below for more details. |
| At least one of the following ... | ||
| consortia | Consortium array of string | See below for more details. See values here |
| submission_centers | SubmissionCenter array of string | See below for more details. See values here |
Identifying Properties
| Property | Type | Description |
|---|---|---|
| accession | string | See below for more details. |
| aliases | array of string | See below for more details. |
| uuid | string | See below for more details. |
Reference Properties
| Property | Type | Description |
|---|---|---|
| consortia | Consortium array of string | See below for more details. See values here |
| sequencing_center | SubmissionCenter string | See below for more details. See values here |
| submission_centers | SubmissionCenter array of string | See below for more details. See values here |
Properties
| Property | Type | Description |
|---|---|---|
| accession | string | A unique identifier to be used to reference the object. [Only admins are allowed to set or update this value.] |
| aliases | array of string • unique • restricted | Institution-specific ID (e.g. bgm:cohort-1234-a). Must adhere to (regex) pattern: ^[^\s\\\/]+:[^\s\\\/]+$ |
| alternate_accessions | array of string • restricted | Accessions previously assigned to objects that have been merged with this object. [Only admins are allowed to set or update this value.] |
| category • Testing | array of enum • min items: 1 • unique | - |
| consortia | Consortium • array of string • unique | Consortia associated with this item. See values here |
| display_title | string • calculated | - |
| href | string • calculated | Use this link to download the QualityMetric zip archive. |
| overall_quality_status • Fail • Pass • Warn | enum of string | Overall QC decision. |
| qc_values | array of object | QC values and their associated metadata. |
| qc_values . derived_from | string | - |
| qc_values . flag • Fail • Pass • Warn | enum of string | - |
| qc_values . key | string | - |
| qc_values . tooltip | string | - |
| qc_values . value | array or boolean or integer or number or string | - |
| qc_values . visible | boolean | - |
| sequencing_center | SubmissionCenter • string | Sequencing Center. See values here |
| status • deleted • draft • in review ← default • obsolete • public • released • restricted | enum of string • default: in review | - |
| submission_centers | SubmissionCenter • array of string • unique | Submission Centers that created this item. See values here |
| tags | array of string • min string length: 1 • max string length: 50 • unique • restricted | Key words that can tag an item - useful for filtering. Must adhere to (regex) pattern: ^[a-zA-Z0-9|_-]+$ |
| url | string • format: uri | Location of the main html file. |
| uuid | string | Unique ID by which this object is identified. |