mzTab-M v2.0 → v2.1 Changes
This page documents every element that was added, removed, or modified between mzTab-M version 2.0 and version 2.1, across all four sections (MTD, SML, SMF, SME).
The comparison is generated automatically from the v2.0 schema reference
(specification_documents/mzTab_m_2_0_schema.adoc) and the current v2.1 field
reference (docs/…/partials/mzTab_m_2_1_schema.adoc) by running:
./gen-docs.sh --changes
1. Summary
| Section | v2.0 elements | v2.1 elements | Added | Removed | Changed |
|---|---|---|---|---|---|
Metadata (MTD) Section |
67 |
75 |
10 |
2 |
65 |
Small Molecule (SML) Section |
17 |
17 |
0 |
0 |
17 |
Small Molecule Feature (SMF) Section |
12 |
12 |
0 |
0 |
12 |
Small Molecule Evidence (SME) Section |
19 |
19 |
0 |
0 |
19 |
2. Metadata (MTD) Section
2.1. 🟢 Added in v2.1
| Column/Field | Description | Type | Mandatory | Nullable |
|---|---|---|---|---|
|
The contact’s orcid id, without https prefix. |
Regex |
False |
— |
|
Additional parameters of the assay, separated by bars. |
Parameter List |
False |
— |
|
The protocol(s) referenced by this assay. |
Integer List |
False |
— |
|
Additional parameters of the assay, separated by bars. |
Parameter List |
False |
— |
|
The ms run(s) referenced by this study variable. |
Integer List |
False |
— |
|
The study variable group this study variable belongs to. |
Integer List |
False |
— |
|
The protocol name. |
String |
True |
— |
|
The protocol type, as defined by the parameter. |
Parameter |
True |
— |
|
Description of the protocol. |
String |
False |
— |
|
The protocol parameters. |
Parameter List |
False |
— |
2.2. 🔴 Removed in v2.1
| Column/Field | Description | Type | Mandatory | Nullable |
|---|---|---|---|---|
|
An identifier for the MS run based on the Universal Spectrum Identifier (USI) specification. |
String |
False |
— |
|
A reference to the study_variable_group that this study variable belongs to, allowing study variables to be linked to the experimental design factors they represent. |
{STUDY_VARIABLE_GROUP_ID} |
True |
— |
2.3. Element Details
2.3.1. mzTab-version
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The version of the mzTab file. The suffix MUST be "-M" for mzTab for metabolomics (mzTab-M). |
Version number of the mzTab format used. |
Type |
Regex |
Regex |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD mzTab-version 2.0.0-M |
---- MTD mzTab-version 2.0.0-M MTD mzTab-version 2.1.0-M ---- |
2.3.2. mzTab-ID
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The ID of the mzTab file, this could be supplied by the repository from which it is downloaded or a local identifier from the lab producing the file. It is not intended to be a globally unique ID but carry some locally useful meaning. |
Unique identifier for the mzTab-M document. |
Type |
String |
String |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD mzTab-ID MTBL1234 |
---- MTD mzTab-ID MTBLS214 MTD mzTab-ID LAB001_2023 ---- |
2.3.3. title
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The file’s human readable title. |
Human-readable title of the experiment or study. |
Type |
String |
String |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD title Effects of Rapamycin on metabolite profile |
---- MTD title Metabolomic Analysis of Human Plasma in Diabetes Type 2 MTD title Lipidomics Study of Brain Tissue in Alzheimer's Disease ---- |
2.3.4. description
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The file’s human readable description. |
Detailed description of the experiment or study. |
Type |
String |
String |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD description An experiment investigating the effects of Il-6. |
---- MTD description Investigation of metabolic changes in human plasma samples from type 2 diabetes patients compared to healthy controls. Study includes both fasting and post-prandial measurements. MTD description Analysis of lipid profiles in brain tissue samples examining the relationship between specific lipid species and Alzheimer's disease progression. ---- |
2.3.5. sample_processing[1-n]
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A list of parameters describing a sample processing, preparation or handling step similar to a biological or analytical methods report. The order of the sample_processing items should reflect the order these processing steps were performed in. If multiple parameters are given for a step these MUST be separated by a “{vbar}”. If derivatization was performed, it MUST be reported here as a general step, e.g. 'silylation' and the actual derivatization agens MUST be specified in the [derivatization_agent1-n] part. |
Parameters specifying sample processing that was applied within one step. |
Type |
Parameter List |
Parameter List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD sample_processing[1] [MSIO, MSIO:0000107, metabolism quenching using precooled 60 percent methanol ammonium bicarbonate buffer,]
MTD sample_processing[2] [MSIO, MSIO:0000146, centrifugation,]
MTD sample_processing[3] [MSIO, MSIO:0000141, metabolite extraction,]
MTD sample_processing[4] [MSIO, MSIO:0000141, silylation,]\{vbar}[MSIO, MSIO:0000116, oximation,]
|
---- MTD sample_processing[1] [MSIO, MSIO:0000107, metabolism quenching using precooled 60 percent methanol ammonium bicarbonate buffer,] MTD sample_processing[2] [MSIO, MSIO:0000146, centrifugation,] MTD sample_processing[3] [MSIO, MSIO:0000141, metabolite extraction,] MTD sample_processing[4] [MSIO, MSIO:0000141, silylation,] ---- |
2.3.6. instrument[1-n]-name
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The name of the instrument used in the experiment. Multiple instruments are numbered 1..n. |
The instrument’s name. |
Type |
Parameter |
Parameter |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD instrument[1]-name [MS, MS:1000449, LTQ Orbitrap,] |
— |
2.3.7. instrument[1-n]-source
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The instrument’s source used in the experiment. Multiple instruments are numbered [1-n]. |
The instrument’s ion source. |
Type |
Parameter |
Parameter |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD instrument[1]-source [MS, MS:1000073, ESI,] … MTD instrument[2]-source [MS, MS:1000598, ETD,] |
— |
2.3.8. instrument[1-n]-analyzer[1-n]
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The instrument’s analyzer type used in the experiment. Multiple instruments are numbered [1-n]. |
The instrument’s mass analyzer, as defined by the parameter. |
Type |
Parameter |
Parameter List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD instrument[1]-analyzer[1] [MS, MS:1000291, linear ion trap,] … MTD instrument[2]-analyzer[1] [MS, MS:1000484, orbitrap,] |
— |
2.3.9. instrument[1-n]-detector
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The instrument’s detector type used in the experiment. Multiple instruments are numbered [1-n]. |
The instrument’s mass analyzer, as defined by the parameter. |
Type |
Parameter |
Parameter |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD instrument[1]-detector [MS, MS:1000253, electron multiplier,] … MTD instrument[2]-detector [MS, MS:1000348, focal plane collector,] |
— |
2.3.10. software[1-n]
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Software used to analyze the data and obtain the reported results. The parameter’s value SHOULD contain the software’s version. The order (numbering) should reflect the order in which the tools were used. |
The software utilized. |
Type |
Parameter |
Parameter |
Mandatory |
True |
False |
Nullable |
— |
— |
Example |
MTD software[1] [MS, MS:1002879, Progenesis QI, 3.0] |
---- MTD software[1] [MS, MS:1002879, Progenesis QI, 3.0] MTD software[1]-setting Fragment tolerance = 0.1 Da … MTD software[2]-setting Parent tolerance = 0.5 Da ---- |
2.3.11. software[1-n]-setting[1-n]
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A software setting used. This field MAY occur multiple times for a single software. The value of this field is deliberately set as a String, since there currently do not exist CV terms for every possible setting. |
A software setting used. This field MAY occur multiple times for a single software. The value of this field is deliberately set as a String, since there currently do not exist cvParams for every possible setting. |
Type |
String |
String List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD software[1]-setting Fragment tolerance = 0.1 Da … MTD software[2]-setting Parent tolerance = 0.5 Da |
— |
2.3.12. publication[1-n]
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A publication associated with this file. Several publications can be given by indicating the number in the square brackets after “publication”. PubMed ids must be prefixed by “pubmed:”, DOIs by “doi:”. Multiple identifiers MUST be separated by “{vbar}”. |
The publication item ids referenced by this publication. |
Type |
String |
String List |
Mandatory |
False |
True |
Nullable |
— |
— |
Example |
MTD publication[1] pubmed:21063943\{vbar}doi:10.1007/978-1-60761-987-1_6
MTD publication[2] pubmed:20615486\{vbar}doi:10.1016/j.jprot.2010.06.008
|
----
MTD publication[1] pubmed:21063943\{vbar}doi:10.1007/978-1-60761-987-1_6
MTD publication[2] pubmed:20615486\{vbar}doi:10.1016/j.jprot.2010.06.008
----
|
2.3.13. contact[1-n]-name
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The contact’s name. Several contacts can be given by indicating the number in the square brackets after "contact". A contact has to be supplied in the format [first name] [initials] [last name] (see example). |
The contact’s name. |
Type |
String |
String |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD contact[1]-name James D. Watson … MTD contact[2]-name Francis Crick |
— |
2.3.14. contact[1-n]-affiliation
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The contact’s affiliation. |
The contact’s affiliation. |
Type |
String |
String |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD contact[1]-affiliation Cambridge University, UK MTD contact[2]-affiliation Cambridge University, UK |
— |
2.3.15. contact[1-n]-email
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The contact’s e-mail address. |
The contact’s e-mail address. |
Type |
String |
String |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD contact[1]-email watson@cam.ac.uk … MTD contact[2]-email crick@cam.ac.uk |
— |
2.3.16. uri[1-n]
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A URI pointing to the file’s source data (e.g., a MetaboLights records). |
The URI pointing to the external resource. |
Type |
URI |
URI |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD uri[1] https://www.ebi.ac.uk/metabolights/MTBLS517 |
---- MTD uri[1] https://www.ebi.ac.uk/metabolights/MTBLS517 … MTD external_study_uri[1] https://www.ebi.ac.uk/metabolights/MTBLS517/files/i_Investigation.txt ---- |
2.3.17. external_study_uri[1-n]
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A URI pointing to an external file with more details about the study design (e.g., an ISA-TAB file). |
The URI pointing to the external resource. |
Type |
URI |
URI |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD external_study_uri[1] https://www.ebi.ac.uk/metabolights/MTBLS517/files/i_Investigation.txt |
---- MTD uri[1] https://www.ebi.ac.uk/metabolights/MTBLS517 … MTD external_study_uri[1] https://www.ebi.ac.uk/metabolights/MTBLS517/files/i_Investigation.txt ---- |
2.3.18. quantification_method
| ⚠️ Changed fields: Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The quantification method used in the experiment reported in the file. |
The quantification method used in the experiment reported in the file. |
Type |
Parameter |
Parameter |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD quantification_method [MS, MS:1001834, LC-MS label-free quantitation analysis, ] MTD quantification_method [MS, MS:1001838, SRM quantitation analysis, ] |
— |
2.3.19. sample[1-n]
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A name for each sample to serve as a list of the samples that MUST be reported in the following tables. Samples MUST be reported if a statistical design is being captured (i.e. bio or tech replicates). If the type of replicates are not known, samples SHOULD NOT be reported. |
The sample’s name. |
Type |
String |
String |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD sample[1] individual number 1 MTD sample[2] individual number 2 |
---- COM Experiment where all samples consisted of the same two species MTD sample[1] individual number 1 MTD sample[1]-species[1] [NCBITaxon, NCBITaxon:9606, Homo sapiens, ] MTD sample[1]-tissue[1] [BTO, BTO:0000759, liver, ] MTD sample[1]-cell_type[1] [CL, CL:0000182, hepatocyte, ] MTD sample[1]-disease[1] [DOID, DOID:684, hepatocellular carcinoma, ] MTD sample[1]-disease[2] [DOID, DOID:9451, alcoholic fatty liver, ] MTD sample[1]-description Hepatocellular carcinoma samples. MTD sample[1]-custom[1] [,,Extraction date, 2011-12-21] MTD sample[1]-custom[2] [,,Extraction reason, liver biopsy] MTD sample[2] individual number 2 MTD sample[2]-species[1] [NCBITaxon, NCBITaxon:9606, Homo sapiens, ] MTD sample[2]-tissue[1] [BTO, BTO:0000759, liver, ] MTD sample[2]-cell_type[1] [CL, CL:0000182, hepatocyte, ] MTD sample[2]-description Healthy control samples. ---- |
2.3.20. sample[1-n]-species[1-n]
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The respective species of the samples analysed. For more complex cases, such as metagenomics, optional columns and userParams should be used. |
Biological species information on the sample. |
Type |
Parameter |
Parameter List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
COM Experiment where all samples consisted of the same two species MTD sample[1]-species[1] [NCBITaxon, NCBITaxon:9606, Homo sapiens, ] MTD sample[2]-species[1] [NCBITaxon, NCBITaxon:39767, Human rhinovirus 11, ] COM Experiment where two samples from different species (combinations) COM were analysed as biological replicates. MTD sample[1]-species[1] [NCBITaxon, NCBITaxon:9606, Homo sapiens, ] MTD sample[1]-species[2] [NCBITaxon, NCBITaxon:39767, Human rhinovirus 11, ] MTD sample[2]-species[1] [NCBITaxon, NCBITaxon:9606, Homo sapiens, ] MTD sample[2]-species[2] [NCBITaxon, NCBITaxon:12130, Human rhinovirus 2, ] |
— |
2.3.21. sample[1-n]-tissue[1-n]
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The respective tissue(s) of the sample. |
Biological tissue information on the sample. |
Type |
Parameter |
Parameter List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD sample[1]-tissue[1] [BTO, BTO:0000759, liver, ] |
— |
2.3.22. sample[1-n]-cell_type[1-n]
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The respective cell type(s) of the sample. |
Biological cell type information on the sample. |
Type |
Parameter |
Parameter List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD sample[1]-cell_type[1] [CL, CL:0000182, hepatocyte, ] |
— |
2.3.23. sample[1-n]-disease[1-n]
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The respective disease(s) of the sample. |
Disease information on the sample. |
Type |
Parameter |
Parameter List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD sample[1]-disease[1] [DOID, DOID:684, hepatocellular carcinoma, ] MTD sample[1]-disease[2] [DOID, DOID:9451, alcoholic fatty liver, ] |
— |
2.3.24. sample[1-n]-description
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A human readable description of the sample. |
A free form description of the sample. |
Type |
String |
String |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD sample[1]-description Hepatocellular carcinoma samples. MTD sample[2]-description Healthy control samples. |
— |
2.3.25. sample[1-n]-custom[1-n]
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Parameters describing the sample’s additional properties. Dates MUST be provided in ISO-8601 format. |
Additional user or cv parameters. |
Type |
Parameter |
Parameter List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD sample[1]-custom[1] [,,Extraction date, 2011-12-21] MTD sample[1]-custom[2] [,,Extraction reason, liver biopsy] |
— |
2.3.26. ms_run[1-n]-location
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Location of the external data file e.g. raw files on which analysis has been performed. If the actual location of the MS run is unknown, a “null” MUST be used as a place holder value, since the [1-n] cardinality is referenced elsewhere. If pre-fractionation has been performed, then [1-n] ms_runs SHOULD be created per assay. |
The msRun’s location URI. |
Type |
URI |
URI |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD ms_run[1]-location file:///C:/path/to/my/file … MTD ms_run[1]-location ftp://ftp.ebi.ac.uk/path/to/file |
— |
2.3.27. ms_run[1-n]-instrument_ref
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
If different instruments are used in different runs, this attribute can be used to link a specific instrument to a specific run. |
Sample reference. |
Type |
Integer |
Integer |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD ms_run[1]-instrument_ref instrument[1] |
— |
2.3.28. ms_run[1-n]-format
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A parameter specifying the data format of the external MS data file. If ms_run[1-n]-format is present, ms_run[1-n]-id_format SHOULD also be present, following the parameters specified in Table 1. |
The format of the MS run file. |
Type |
Parameter |
Parameter |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD ms_run[1]-format [MS, MS:1000584, mzML file, ] MTD ms_run[1]-id_format [MS, MS:1000530, mzML unique identifier, ] … MTD ms_run[2]-format [MS, MS:1001062, Mascot MGF file, ] MTD ms_run[2]-id_format [MS, MS:1000774, multiple peak list nativeID format, ] |
— |
2.3.29. ms_run[1-n]-id_format
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Parameter specifying the id format used in the external data file. If ms_run[1-n]-id_format is present, ms_run[1-n]-format SHOULD also be present. |
The format of the IDs in the MS run file. |
Type |
Parameter |
Parameter |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD ms_run[1]-format [MS, MS:1000584, mzML file, ] MTD ms_run[1]-id_format [MS, MS:1000530, mzML unique identifier, ] … MTD ms_run[2]-format [MS, MS:1001062, Mascot MGF file, ] MTD ms_run[2]-id_format [MS, MS:1000774, multiple peak list nativeID format, ] |
— |
2.3.30. ms_run[1-n]-usi_identifier 🔴 (Removed in v2.1)
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
An identifier for the MS run based on the Universal Spectrum Identifier (USI) specification. |
(not present) |
Type |
String |
(not present) |
Mandatory |
False |
(not present) |
Nullable |
— |
(not present) |
Example |
MTD ms_run[1]-usi_identifier mzspec:PXD000561:Adult_Frontalcortex_bRP_Elite_85_f09 |
(not present) |
2.3.31. ms_run[1-n]-fragmentation_method[1-n]
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The type(s) of fragmentation used in a given ms run. |
The fragmentation methods applied during this msRun. |
Type |
Parameter |
Parameter List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD ms_run[1]-fragmentation_method[1] [MS, MS:1000133, CID, ] … MTD ms_run[1]-fragmentation_method[2] [MS, MS:1000422, HCD, ] |
— |
2.3.32. ms_run[1-n]-scan_polarity[1-n]
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The polarity mode of a given run. Usually only one value SHOULD be given here except for the case of mixed polarity runs. |
The scan polarity/polarities used during this msRun. |
Type |
Parameter |
Parameter List |
Mandatory |
True |
False |
Nullable |
— |
— |
Example |
MTD ms_run[1]-scan_polarity[1] [MS, MS:1000130, positive scan, ] OR MTD ms_run[1]-scan_polarity[1] [MS, MS:1000129, negative scan, ] OR (For mixed polarity in one run) MTD ms_run[1]-scan_polarity[1] [MS, MS:1000130, positive scan, ] MTD ms_run[1]-scan_polarity[2] [MS, MS:1000129, negative scan, ] |
— |
2.3.33. ms_run[1-n]-hash
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Hash value of the corresponding external MS data file defined in ms_run[1-n]-location. If ms_run[1-n]-hash is present, ms_run[1-n]-hash_method SHOULD also be present. |
The file hash value of this msRun’s data file. |
Type |
String |
String |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD ms_run[1]-hash_method [MS, MS:1000569, SHA-1, ] MTD ms_run[1]-hash de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b3 |
— |
2.3.34. ms_run[1-n]-hash_method
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A parameter specifying the hash methods used to generate the String in ms_run[1-n]-hash. Specifics of the hash method used MAY follow the definitions of the mzML format. If ms_run[1-n]-hash is present, ms_run[1-n]-hash_method SHOULD also be present. |
The method used to calculate the hash. |
Type |
Parameter |
Parameter |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD ms_run[1]-hash_method [MS, MS:1000569, SHA-1, ] MTD ms_run[1]-hash de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b3 |
— |
2.3.35. assay[1-n]
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A name for each assay, to serve as a list of the assays that MUST be reported in the following tables. |
The assay name. |
Type |
String |
String |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD assay[1] first assay MTD assay[2] second assay |
---- MTD assay[1] first assay MTD assay[1]-custom[1] [MS, , Assay operator, Fred Blogs] MTD assay[1]-external_uri https://www.ebi.ac.uk/metabolights/MTBLS517/files/i_Investigation.txt?STUDYASSAY=a_e04_c18pos.txt MTD assay[1]-sample_ref sample[1] MTD assay[1]-ms_run_ref ms_run[1] ---- |
2.3.36. assay[1-n]-custom[1-n]
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Additional parameters or values for a given assay. |
Additional user or cv parameters. |
Type |
Parameter |
Parameter List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD assay[1]-custom[1] [MS, , Assay operator, Fred Blogs] |
— |
2.3.37. assay[1-n]-external_uri
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A reference to further information about the assay, for example via a reference to an object within an ISA-TAB file. |
An external URI to further information about this assay. |
Type |
URI |
URI |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD assay[1]-external_uri https://www.ebi.ac.uk/metabolights/MTBLS517/files/i_Investigation.txt?STUDYASSAY=a_e04_c18pos.txt |
— |
2.3.38. assay[1-n]-sample_ref
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
An association from a given assay to the sample analysed. |
Sample reference. |
Type |
{SAMPLE_ID} |
Integer |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD assay[1]-sample_ref sample[1] MTD assay[2]-sample_ref sample[2] |
— |
2.3.39. assay[1-n]-ms_run_ref
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
An association from a given assay to the source MS run. All assays MUST reference exactly one ms_run unless a workflow with pre-fractionation is being encoded, in which case each assay MUST reference n ms_runs where n fractions have been collected. |
The ms run(s) referenced by this assay. |
Type |
{MS_RUN_ID} |
Integer List |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD assay[1]-ms_run_ref ms_run[1] MTD assay[1]-ms_run_ref ms_run[2] |
— |
2.3.40. study_variable[1-n]
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A name for each study variable (experimental condition or factor), to serve as a list of the study variables that MUST be reported in the following tables. For software that does not capture study variables, a single study variable MUST be reported, linking to all assays. This single study variable MUST have the identifier “undefined“. |
The study variable value. Encoded according to the datatype declared on the referenced study_variable_group: either a literal value (for xsd: datatypes) or a Parameter (for the Parameter datatype, e.g. |
Type |
String |
Study Variable List |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD study_variable[1] “control” MTD study_variable[2] “1 minute” MTD study_variable[13] “Wildtype” |
----
MTD study_variable[1] control
MTD study_variable[1]-assay_refs assay[1]\{vbar} assay[2]\{vbar} assay[3]
MTD study_variable-average_function [MS, MS:1002883, median, ]
MTD study_variable-variation_function [MS, MS:1002885, standard error, ]
MTD study_variable[1]-description Group B (spike-in 0.74 fmol/uL)
MTD study_variable[2] 1 minute 0.5mg rapamycin
----
|
2.3.41. study_variable[1-n]-assay_refs
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Bar-separated references to the IDs of assays grouped in the study variable. |
The assays referenced by this study variable. |
Type |
{ASSAY_ID}, … |
Integer List |
Mandatory |
True |
False |
Nullable |
— |
— |
Example |
MTD study_variable[1]-assay_refs assay[1]\{vbar} assay[2]\{vbar} assay[3]
|
— |
2.3.42. study_variable[1-n]-description
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A textual description of the study variable. |
A free-form description of this study variable. |
Type |
String |
String |
Mandatory |
True |
False |
Nullable |
— |
— |
Example |
MTD study_variable[1]-description Group B (spike-in 0.74 fmol/uL) |
— |
2.3.43. study_variable[1-n]-group_ref 🔴 (Removed in v2.1)
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A reference to the study_variable_group that this study variable belongs to, allowing study variables to be linked to the experimental design factors they represent. |
(not present) |
Type |
{STUDY_VARIABLE_GROUP_ID} |
(not present) |
Mandatory |
True |
(not present) |
Nullable |
— |
(not present) |
Example |
MTD study_variable[1]-group_ref study_variable_group[1] MTD study_variable[2]-group_ref study_variable_group[1] MTD study_variable[3]-group_ref study_variable_group[2] |
(not present) |
2.3.44. study_variable_group[1-n]
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A parameter defining the group to which the study variable belongs. This allows grouping of related study variables that belong to the same experimental design factor in multi-factorial designs. The parameter can be either a CV Parameter or a user-defined parameter. At least one study_variable_group MUST be defined. For software that does not capture study variables, a single study_variable_group MUST be reported, linking to the single study variable. This single study_variable_group MUST have the identifier “undefined”. Added in mzTab-M 2.1. |
The study variable group name. |
Type |
Parameter |
Parameter |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD study_variable_group[1] [,,sex,] MTD study_variable_group[2] [EFO, EFO:0004953, date of diagnosis, ] |
----
MTD study_variable_group[1] [PATO, PATO:0000383, sex, ]
MTD study_variable_group[1]-description Sex of the individual
MTD study_variable_group[1]-type [STATO, STATO:0000252, categorical variable, ]
MTD study_variable_group[1]-datatype xsd:string
MTD study_variable_group[2] [PATO, PATO:0000384, timepoint, ]
MTD study_variable_group[2]-description Time after treatment
MTD study_variable_group[2]-type [STATO, STATO:0000228, ordinal variable, ]
MTD study_variable_group[2]-datatype xsd:integer
MTD study_variable_group[2]-unit [UO, UO:0000033, day, ]
MTD study_variable[1] Female_0day
MTD study_variable[1]-group_ref study_variable_group[1]
MTD study_variable[1]-assay_refs assay[1]\{vbar}assay[2]\{vbar}assay[3]
MTD study_variable[2] Female_1day
MTD study_variable[2]-group_ref study_variable_group[2]
MTD study_variable[2]-assay_refs assay[4]\{vbar}assay[5]\{vbar}assay[6]
----
|
2.3.45. study_variable_group[1-n]-description
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A textual description of the study variable group. |
Description of the study variable group. |
Type |
String |
String |
Mandatory |
True (if study_variable_group is defined) |
False |
Nullable |
— |
— |
Example |
MTD study_variable_group[1]-description Sex of the individual |
— |
2.3.46. study_variable_group[1-n]-type
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The statistical type of the group variable, which determines how the values should be interpreted in a statistical analysis context. The type MUST be a term from the STATO ontology, and SHOULD be one of the examples below. While the |
The study variable group type, as defined by the parameter. |
Type |
Parameter |
Parameter |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD study_variable_group[1]-type [STATO, STATO:0000252, categorical variable] MTD study_variable_group[2]-type [STATO, STATO:0000228, ordinal variable] MTD study_variable_group[3]-type [STATO, STATO:0000251, continuous variable] |
— |
2.3.47. study_variable_group[1-n]-datatype
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The datatype of the group variable, which determines how they can be encoded and parsed in mzTab-M files, and how the values could be handled in programming languages. |
The datatype of the group variable, which determines how they can be encoded and parsed in mzTab-M files, and how the values could be handled in programming languages. |
Type |
String (constrained) |
Parameter |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD study_variable_group[1]-datatype xsd:string MTD study_variable_group[2]-datatype xsd:decimal MTD study_variable_group[3]-datatype xsd:date |
---- MTD study_variable_group[1]-datatype .... MTD study_variable_group[1]-datatype xsd:string MTD study_variable_group[2]-datatype xsd:decimal MTD study_variable_group[3]-datatype xsd:date MTD study_variable_group[4]-datatype Parameter COM plain string value: MTD study_variable[1] Male MTD study_variable[1]-group_ref study_variable_group[1] COM user-defined Parameter value: MTD study_variable[2] [,,Male,] MTD study_variable[2]-group_ref study_variable_group[4] COM CV Parameter value: MTD study_variable[3] [NCIT, NCIT:C20197, Male, ] MTD study_variable[3]-group_ref study_variable_group[4] ---- |
2.3.48. study_variable_group[1-n]-unit
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
An optional parameter specifying the unit of the study variable group (e.g., day, hour, concentration, etc.). This SHOULD only be used for numeric or scalar values. |
The study variable group unit, as defined by the parameter. |
Type |
Parameter |
Parameter |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD study_variable_group[1]-unit [UO, UO:0000033, day, ] MTD study_variable_group[2]-unit [UO, UO:0000010, second, ] |
— |
2.3.49. study_variable[1-n]-average_function
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The function used to calculate the study variable quantification value and the operation used is not arithmetic mean (default) e.g. “geometric mean”, “median”. The 1-n refers to different study variables. |
The function used to calculate the study variable quantification value and the operation used is not arithmetic mean (default). e.g. geometric mean, median. |
Type |
Parameter |
Parameter |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD study_variable-average_function [MS, MS:1002883, median, ] |
— |
2.3.50. study_variable[1-n]-variation_function
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The function used to calculate the study variable quantification variation value if it is reported and the operation used is not coefficient of variation (default) e.g. “standard error”. |
The function used to calculate the study variable quantification variation value if it is reported and the operation used is not coefficient of variation (default). e.g. standard error. |
Type |
Parameter |
Parameter |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD study_variable-variation_function [MS, MS:1002885, standard error, ] |
— |
2.3.51. custom[1-n]
| ⚠️ Changed fields: Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Any additional parameters describing the analysis reported. |
Any additional parameters describing the analysis reported. |
Type |
Parameter |
Parameter List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD custom[1] [,,MS operator, Florian] |
---- MTD custom [MS, MS:1000001, custom param, value] ---- |
2.3.52. cv[1-n]-label
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A string describing the labels of the controlled vocabularies/ontologies used in the mzTab file as a short-hand e.g. "MS" for PSI-MS. |
The abbreviated CV label. |
Type |
String |
String |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD cv[1]-label MS |
— |
2.3.53. cv[1-n]-full_name
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A string describing the full names of the controlled vocabularies/ontologies used in the mzTab file. |
The full name of this CV, for humans. |
Type |
String |
String |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD cv[1]-full_name PSI-MS controlled vocabulary |
— |
2.3.54. cv[1-n]-version
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A string describing the version of the controlled vocabularies/ontologies used in the mzTab file. |
The CV version used when the file was generated. |
Type |
String |
String |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD cv[1]-version 4.1.11 |
— |
2.3.55. cv[1-n]-uri
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A string containing the URIs of the controlled vocabularies/ontologies used in the mzTab file. Note: For OBO ontologies, always use an OBO PURL rather than raw repository links to ensure long-term stability. For other ontology formats, please use the fully qualified PURL pointing to the ontology file. |
A URI to the CV definition. |
Type |
String |
URI |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD cv[1]-uri https://purl.obolibrary.org/obo/ms.obo |
— |
2.3.56. database[1-n]
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The description of databases used. For cases, where a known database has not been used for identification, a userParam SHOULD be inserted to describe any identification performed e.g. de novo. |
The database name. |
Type |
Param |
Database List |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD database[1] [MIRIAM, MIR:00100079, HMDB, ] MTD database[2] [,, "de novo", ] MTD database[3] [MIRIAM, MIR:00000002, CHEBI, ] MTD database[4] [,, "customDB", ] OR MTD database[5] [,, "no database", null ] |
---- MTD database[1] [MIRIAM, MIR:00100079, HMDB, ] MTD database[1]-prefix hmdb MTD database[1]-version 3.6 MTD database[1]-uri https://www.hmdb.ca MTD database[2] [,, "de novo", ] MTD database[2]-prefix dn MTD database[2]-version Unknown MTD database[2]-uri null MTD database[3] [,, "no database", null ] MTD database[3]-prefix null MTD database[3]-version Unknown MTD database[3]-uri null ---- |
2.3.57. database[1-n]-prefix
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The prefix used in the “identifier” column of data tables. For the “no database” case "null" must be used. |
The prefix used in the “identifier” column of data tables. For the 'no database' case 'null' must be used. |
Type |
String |
String |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD database[1]-prefix hmdb MTD database[2]-prefix dn MTD database[3]-prefix chebi MTD database[4]-prefix cust OR MTD database[5]-prefix null |
— |
2.3.58. database[1-n]-version
| ⚠️ Changed fields: Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The database version is mandatory where identification has been performed. This may be a formal version number e.g. “1.4.1”, a date of access “2016-10-27” (ISO-8601 format) or “Unknown” if there is no suitable version that can be annotated. |
The database version is mandatory where identification has been performed. This may be a formal version number e.g. “1.4.1”, a date of access “2016-10-27” (ISO-8601 format) or “Unknown” if there is no suitable version that can be annotated. |
Type |
String |
String |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD database[1]-version 3.6 OR MTD database[2]-version Unknown |
— |
2.3.59. database[1-n]-uri
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The URI to the database. For the “no database” case, "null" must be reported. |
The URI to the database. For the “no database” case, 'null' must be reported. |
Type |
URI |
String |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD database[1]-uri http://www.hmdb.ca/ OR MTD database[5]-uri null |
— |
2.3.60. derivatization_agent[1-n]
| ⚠️ Changed fields: Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A description of derivatization agents applied to small molecules, using userParams or CV terms where possible. |
A description of derivatization agents applied to small molecules, using userParams or CV terms where possible. |
Type |
Param |
Parameter List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD derivatization_agent[1] [XLMOD, XLMOD:07014, N-methyl-N-t-butyldimethylsilyltrifluoroacetamide, ] |
---- MTD derivatization_agent[1] [XLMOD, XLMOD:07014, N-methyl-N-t-butyldimethylsilyltrifluoroacetamide, ] ---- |
2.3.61. small_molecule-quantification_unit
| ⚠️ Changed fields: Description, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Defines what type of units are reported in the small molecule summary quantification / abundance fields. |
Defines what type of units are reported in the small molecule summary quantification / abundance fields |
Type |
Parameter |
Parameter |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
MTD small_molecule-quantification_unit [MS, MS:1002887, Progenesis QI normalised abundance, ] |
---- MTD small_molecule-quantification_unit [MS, MS:1001113, peak area, ] ---- |
2.3.62. small_molecule_feature-quantification_unit
| ⚠️ Changed fields: Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Defines what type of units are reported in the small molecule feature quantification / abundance fields. |
Defines what type of units are reported in the small molecule feature quantification / abundance fields. |
Type |
Parameter |
Parameter |
Mandatory |
True (if SMF section is being reported) |
False |
Nullable |
— |
— |
Example |
MTD small_molecule_feature-quantification_unit [MS, MS:1002887, Progenesis QI normalised abundance, ] |
---- MTD small_molecule_feature-quantification_unit [MS, MS:1001113, peak area, ] ---- |
2.3.63. small_molecule-identification_reliability
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The system used for giving reliability / confidence codes to small molecule identifications MUST be specified if not using the default codes (see [reliability] and for details). |
The system used for giving reliability / confidence codes to small molecule identifications MUST be specified if not using the default codes. |
Type |
Param |
Parameter |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD small_molecule-identification_reliability [MS, MS:1002896, compound identification confidence level, ] or MTD small_molecule-identification_reliability [MS, MS:1002955, hr-ms compound identification confidence level, ] |
---- MTD small_molecule-identification_reliability [MS, MS:1000932, identification reliability, ] ---- |
2.3.64. id_confidence_measure[1-n]
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The type of small molecule confidence measures or scores MUST be reported as a CV parameter [1-n]. The CV parameter definition should formally state whether the ordering is high to low or vice versa. The order of the scores SHOULD reflect their importance for the identification and be used to determine the identification’s rank. |
Small molecule identification confidence metrics.<br/>Scoring System |
Type |
Parameter |
Parameter List |
Mandatory |
True |
True |
Nullable |
— |
— |
Example |
id_confidence_measure[1] [MS,MS:1002889,Progenesis MetaScope Score,] id_confidence_measure[2] [MS,MS:1002890,fragmentation score,] id_confidence_measure[3] [MS,MS:1002891,isotopic fit score,] |
---- MTD id_confidence_measure[1] [MS,MS:1002890,fragmentation score,] MTD id_confidence_measure[2] [MS,MS:1002891,retention time score,] ---- |
2.3.65. colunit-small_molecule
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Defines the used unit for a column in the small molecule section. The format of the value has to be \{column name}=\{Parameter defining the unit} |
Unit definitions for small molecule data columns. |
Type |
String |
Column Parameter Mapping List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD colunit-small_molecule opt_global_cv_MS:MS:1002954_collisional_cross_sectional_area=[UO,UO:00003241, square angstrom,] |
---- MTD colunit-small_molecule retention_time=[UO,UO:0000031,minute,] MTD colunit-small_molecule mass=[UO,UO:0000221,dalton,] ---- |
2.3.66. colunit-small_molecule_feature
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Defines the used unit for a column in the small molecule feature section. The format of the value has to be \{column name}=\{Parameter defining the unit} |
Defines the used unit for a column in the small molecule feature section. The format of the value has to be {column name}={Parameter defining the unit}. This field MUST NOT be used to define a unit for quantification columns. The unit used for small molecule quantification values MUST be set in small_molecule_feature-quantification_unit. |
Type |
String |
Column Parameter Mapping List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD colunit-small_molecule_feature opt_ms_run[1]_cv_MS:MS:1002476_ion_mobility_drift_time=[UO,UO:0000031, minute,] |
---- MTD colunit-small_molecule_feature retention_time=[UO, UO:0000031, minute, ] ---- |
2.3.67. colunit-small_molecule_evidence
| ⚠️ Changed fields: Description, Type, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Defines the used unit for a column in the small molecule evidence section. The format of the value has to be \{column name}=\{Parameter defining the unit}. |
Defines the used unit for a column in the small molecule evidence section. The format of the value has to be {column name}={Parameter defining the unit}. |
Type |
String |
Column Parameter Mapping List |
Mandatory |
False |
False |
Nullable |
— |
— |
Example |
MTD colunit-small_molecule_evidence opt_global_mass_error=[UO, UO:0000169, parts per million, ] |
---- MTD colunit-small_molecule_evidence retention_time=[UO, UO:0000031, minute, ] ---- |
2.3.68. contact[1-n]-orcid 🟢 (Added in v2.1)
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
(not present) |
The contact’s orcid id, without https prefix. |
Type |
(not present) |
Regex |
Mandatory |
(not present) |
False |
Nullable |
(not present) |
— |
Example |
(not present) |
— |
2.3.69. ms_run[1-n]-parameters[1-n] 🟢 (Added in v2.1)
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
(not present) |
Additional parameters of the assay, separated by bars. |
Type |
(not present) |
Parameter List |
Mandatory |
(not present) |
False |
Nullable |
(not present) |
— |
Example |
(not present) |
---- MTD ms_run[1]-parameter[1] [MS, MS:1000031, instrument model, [MS, MS:1000449, LTQ Orbitrap,]] ---- |
2.3.70. assay[1-n]-protocol_refs[1-n] 🟢 (Added in v2.1)
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
(not present) |
The protocol(s) referenced by this assay. |
Type |
(not present) |
Integer List |
Mandatory |
(not present) |
False |
Nullable |
(not present) |
— |
Example |
(not present) |
----
MTD assay[1]-protocol_ref protocol[1]\{vbar} protocol[2]
----
|
2.3.71. assay[1-n]-parameters[1-n] 🟢 (Added in v2.1)
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
(not present) |
Additional parameters of the assay, separated by bars. |
Type |
(not present) |
Parameter List |
Mandatory |
(not present) |
False |
Nullable |
(not present) |
— |
Example |
(not present) |
---- MTD assay[1]-parameter[1] [MS, MS:1000031, instrument model, [MS, MS:1000449, LTQ Orbitrap,]] ---- |
2.3.72. study_variable[1-n]-ms_run_refs[1-n] 🟢 (Added in v2.1)
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
(not present) |
The ms run(s) referenced by this study variable. |
Type |
(not present) |
Integer List |
Mandatory |
(not present) |
False |
Nullable |
(not present) |
— |
Example |
(not present) |
----
MTD study_variable[1]-ms_run_ref ms_run[1]\{vbar} ms_run[2]
----
|
2.3.73. study_variable[1-n]-group_refs[1-n] 🟢 (Added in v2.1)
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
(not present) |
The study variable group this study variable belongs to. |
Type |
(not present) |
Integer List |
Mandatory |
(not present) |
False |
Nullable |
(not present) |
— |
Example |
(not present) |
----
MTD study_variable[1]-group_ref study_variable_group[1]\{vbar} study_variable_group[2]
----
|
2.3.74. protocol[1-n]-name 🟢 (Added in v2.1)
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
(not present) |
The protocol name. |
Type |
(not present) |
String |
Mandatory |
(not present) |
True |
Nullable |
(not present) |
— |
Example |
(not present) |
— |
2.3.75. protocol[1-n]-type 🟢 (Added in v2.1)
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
(not present) |
The protocol type, as defined by the parameter. |
Type |
(not present) |
Parameter |
Mandatory |
(not present) |
True |
Nullable |
(not present) |
— |
Example |
(not present) |
— |
3. Small Molecule (SML) Section
3.1. Element Details
3.1.1. SML_ID
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A within file unique identifier for the small molecule. |
A within file unique identifier for the small molecule summary. |
Type |
Integer |
Integer |
Mandatory |
— |
True |
Nullable |
False |
False |
Example |
SMH SML_ID … SML 1 … SML 2 … |
---- SMH ... SML_ID ... SML ... 1 ... ---- |
3.1.2. SMF_ID_REFS
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
References to all the features on which quantitation has been based (SMF elements) via referencing SMF_ID values. Multiple values SHOULD be provided as a “{vbar}” separated list. This MAY be null only if this is a Summary file. |
References to the small molecule features (SMF elements) via referencing SMF_ID values. Multiple values MAY be provided as a {vbar} separated list to indicate which features were used to aggregate the SML row. |
Type |
{SMF_ID} list |
Integer List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID SMF_ID_REFS
SML 1 2\{vbar}3\{vbar}11…
|
----
SMH ... SMF_ID_REFS ...
SML ... 2\{vbar}3\{vbar}11 ...
----
|
3.1.3. database_identifier
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A list of “{vbar}” separated possible identifiers for the small molecule; multiple values MUST only be provided to indicate ambiguity in the identification of the molecule and not to demonstrate different identifier types for the same molecule. Alternative identifiers for the same molecule MAY be provided as optional columns. |
A list of {vbar} separated possible identifiers for the small molecule; multiple values MUST only be provided to indicate ambiguity in the identification of the molecule and not to demonstrate different identifier types for the same molecule. Alternative identifiers for the same molecule MAY be provided as optional columns. The database identifier must be preceded by the resource description (prefix) followed by a colon, as specified in the metadata section. A null value MAY be provided if the identification is sufficiently ambiguous as to be meaningless for reporting or the small molecule has not been identified. |
Type |
String List |
String List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID database_identifier … SML 1 CID:00027395 … SML 2 HMDB:HMDB0001847 SML 3 null |
----
SMH ... database_identifier ...
SML ... CID:00027395\{vbar}HMDB:HMDB0001847 ...
----
|
3.1.4. chemical_formula
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A list of “{vbar}” separated potential chemical formulae of the reported compound. The number of values provided MUST match the number of entities reported under “database_identifier”, even if this leads to redundant reporting of information (i.e. if ambiguity can be resolved in the chemical formula), and the validation software will throw an error if the number of “{vbar}” symbols does not match. “null” values between bars are allowed. |
The chemical formula of the identified compound e.g. in a database, assumed to match the theoretical mass to charge (in some cases this will be the derivatized form, including adducts and protons). This should be specified in Hill notation (EA Hill 1900), i.e. elements in the order C, H and then alphabetically all other elements. Counts of one may be omitted. Elements should be capitalized properly to avoid confusion (e.g., “CO” vs. “Co”). The chemical formula reported should refer to the neutral form. Charge state is reported by the charge field in the SME and SMF section. |
Type |
String List |
String List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID … chemical_formula … SML 1 … C17H20N4O2 … |
---- SMH ... chemical_formula ... SML ... C17H20N4O2 ... ---- |
3.1.5. smiles
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A list of “{vbar}” separated potential molecule structures in the simplified molecular-input line-entry system (SMILES) for the small molecule. The number of values provided MUST match the number of entities reported under “database_identifier”, and the validation software will throw an error if the number of “{vbar}” symbols does not match. “null” values between bars are allowed. |
The potential molecule’s structure in the simplified molecular-input line-entry system (SMILES) for the small molecule. |
Type |
String List |
String List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID … chemical_formula smiles … SML 1 … C17H20N4O2 C1=CC=C(C=C1)CCNC(=O)CCNNC(=O)C2=CC=NC=C2 … |
---- SMH ... smiles ... SML ... C1=CC=C(C=C1)CCNC(=O)CCNNC(=O)C2=CC=NC=C2 ... ---- |
3.1.6. inchi
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A list of “{vbar}” separated potential standard IUPAC International Chemical Identifier (InChI) of the given substance. |
A standard IUPAC International Chemical Identifier (InChI) for the given substance. |
Type |
String List |
String List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID … chemical_formula … inchi … SML 1 … C17H20N4O2 … InChI=1S/C17H20N4O2/c22-16(19-12-6-14-4-2-1-3-5-14)9-13-20-21-17(23)15-7-10-18-11-8-15/h1-5,7-8,10-11,20H,6,9,12-13H2,(H,19,22)(H,21,23) … |
---- SMH ... inchi ... SML ... InChI=1S/C17H20N4O2/c22-16(19-12-6-14-4-2-1-3-5-14)9-13-20-21-17(23)15-7-10-18-11-8-15/h1-5,7-8,10-11,20H,6,9,12-13H2,(H,19,22)(H,21,23) ... ---- |
3.1.7. chemical_name
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A list of “{vbar}” separated possible chemical/common names for the small molecule, or general description if a chemical name is unavailable. Multiple names are only to demonstrate ambiguity in the identification. The number of values provided MUST match the number of entities reported under “database_identifier”, and the validation software will throw an error if the number of “{vbar}” symbols does not match. “null” values between bars are allowed. |
The small molecule’s chemical/common name, or general description if a chemical name is unavailable. |
Type |
String List |
String List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID … description … SML 1 … N-(2-phenylethyl)-3-[2-(pyridine-4-carbonyl)hydrazinyl]propanamide… |
---- SMH ... chemical_name ... SML ... N-(2-phenylethyl)-3-[2-(pyridine-4-carbonyl)hydrazinyl]propanamide ... ---- |
3.1.8. uri
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A URI pointing to the small molecule’s entry in a reference database (e.g., the small molecule’s HMDB or KEGG entry). The number of values provided MUST match the number of entities reported under “database_identifier”, and the validation software will throw an error if the number of “{vbar}” symbols does not match. “null” values between bars are allowed. |
A URI pointing to the small molecule’s entry in a database (e.g., the small molecule’s HMDB, Chebi or KEGG entry). |
Type |
URI List |
String List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID … uri … SML 1 … http://www.genome.jp/dbget-bin/www_bget?cpd:C00031 … SML 2 … http://www.hmdb.ca/metabolites/HMDB0001847 … SML 3 … http://identifiers.org/hmdb/HMDB0001847 … |
---- SMH ... uri ... SML ... http://www.genome.jp/dbget-bin/www_bget?cpd:C00031 ... SML ... http://www.hmdb.ca/metabolites/HMDB0001847 ... ---- |
3.1.9. theoretical_neutral_mass
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The small molecule’s precursor’s theoretical neutral mass. |
The theoretical neutral mass of the small molecule. This should be calculated from the chemical formula. |
Type |
Double List |
Double List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID … theoretical_neutral_mass … SML 1 … 1234.5 … |
---- SMH ... theoretical_neutral_mass ... SML ... 1234.5 ... ---- |
3.1.10. adduct_ions
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A “{vbar}” separated list of detected adducts for this this molecule, following the general style in the 2013 IUPAC recommendations on terms relating to MS e.g. |
A {vbar} separated list of the detected adduct ion forms for this small molecule. The terms should follow the general style in the 2013 IUPAC recommendations on terms relating to MS e.g. [M+H]1+, [M+Na]1+, [M+NH4]1+, [M-H]1-, [M+Cl]1-. |
Type |
Regex List |
Regex List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID … adduct_ions …
SML 1 … [M+H]1+ \{vbar} [M+Na]1+ …
|
----
SMH ... adduct_ions ...
SML ... [M+H]1+\{vbar}[M+Na]1+ ...
----
|
3.1.11. reliability
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The reliability of the given small molecule identification. This must be supplied by the resource and MUST be reported as an integer between 1-4: |
The reliability of the given small molecule identification. This must be supplied by the resource and should be reported as an integer between 1-4: |
Type |
String |
String |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH identifier … reliability … SML 1 … 3 … or MTD small_molecule-identification_reliability [MS, MS:1002896, compound identification confidence level,] … SMH identifier … reliability … SML 1 … 0 … or MTD small_molecule-identification_reliability [MS, MS:1002955, hr-ms compound identification confidence level,] … SMH identifier … reliability … SML 1 … 2a … |
---- SMH ... reliability ... SML ... 3 ... SML ... 0 ... ---- |
3.1.12. best_id_confidence_measure
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The approach or database search that identified this small molecule with highest confidence. |
The small molecule confidence measure/score of the best identification for this small molecule summary. The type of the value is defined by the best_id_confidence_measure CV parameter. The value is reported in the best_id_confidence_value column. |
Type |
Parameter |
Parameter |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID … best_ id_confidence_measure … SML 1 … [MS, MS:1001477, SpectraST,] … |
---- SMH ... best_id_confidence_measure ... SML ... [MS, MS:1001477, SpectraST,,] ... ---- |
3.1.13. best_id_confidence_value
| ⚠️ Changed fields: Description, Mandatory, Nullable, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The best confidence measure in identification (for this type of score) for the given small molecule across all assays. The type of score MUST be defined in the metadata section. If the small molecule was not identified by the specified search engine, “null” MUST be reported. If the confidence measure does not report a numerical confidence value, “null” SHOULD be reported. |
The small molecule confidence measure/score value of the best identification for this small molecule summary. |
Type |
Double |
Double |
Mandatory |
— |
True |
Nullable |
True |
False |
Example |
SMH SML_ID … best_id_confidence_value … SML 1 … 0.7 … |
---- SMH ... best_id_confidence_value ... SML ... 0.85 ... ---- |
3.1.14. abundance_assay[1-n]
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The small molecule’s abundance in every assay described in the metadata section MUST be reported. Null or zero values may be reported as appropriate. "null" SHOULD be used to report missing quantities, while zero SHOULD be used to indicate a present but not reliably quantifiable value (e.g. below a minimum noise threshold). |
The small molecule’s abundance in every assay described in the metadata section MUST be reported. Null or zero values may be reported as appropriate. |
Type |
Double |
Double List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID … abundance_assay[1] … SML 1 … 0.3 … |
---- SMH ... abundance_assay ... SML ... 12340 ... ---- |
3.1.15. abundance_study_variable[1-n]
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The small molecule’s abundance in all the study variables described in the metadata section (study_variable[1-n]_average_function), calculated using the method as described in the Metadata section (default = arithmetic mean across assays). Null or zero values may be reported as appropriate. "null" SHOULD be used to report missing quantities, while zero SHOULD be used to indicate a present but not reliably quantifiable value (e.g. below a minimum noise threshold). |
The small molecule’s abundance in every study variable described in the metadata section. Null or zero values may be reported as appropriate. |
Type |
Double |
Double List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID … abundance_study_variable[1] … SML 1 … 0.3 … |
---- SMH ... abundance_study_variable ... SML ... 1230 ... ---- |
3.1.16. abundance_variation_study_variable[1-n]
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A measure of the variability of the study variable abundance measurement, calculated using the method as described in the metadata section (study_variable[1-n]_average_function), with a default = arithmethic co-efficient of variation of the small molecule’s abundance in the given study variable. |
The small molecule’s abundance variation in every study variable described in the metadata section. Null or zero values may be reported as appropriate. |
Type |
Double |
Double List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID … abundance_study_variable[1] abundance_variation_study_variable[1]… SML 1 … 0.3 0.04 … |
---- SMH ... abundance_variation_study_variable ... SML ... 0.2 ... ---- |
3.1.17. opt_{identifier}_*
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Additional columns can be added to the end of the small molecule table. These column headers MUST start with the prefix “opt_” followed by the {identifier} of the object they reference: assay, study variable, MS run or “global” (if the value relates to all replicates). Column names MUST only contain the following characters: ‘A’-‘Z’, ‘a’-‘z’, ‘0’-‘9’, ‘’, ‘-’, ‘[’, ‘]’, and ‘:’. CV parameter accessions MAY be used for optional columns following the format: opt_{identifier}_cv_{accession}_{parameter name}. Spaces within the parameter’s name MUST be replaced by ‘’. |
Additional columns can be added to the end of the small molecule table. These column headers MUST start with the prefix “opt_” followed by the {identifier} of the object they reference: assay, study variable, MS run or “global” (if the value relates to all replicates). Column names MUST only contain the following characters: 'A'-'Z', 'a'-'z', '0'-'9', '', '-', '[', ']', and ':'. CV parameter accessions MAY be used for optional columns following the format: opt{identifier}_cv_{accession}_{parameter name}. Spaces within the parameter’s name MUST be replaced by '_'. |
Type |
Column |
Optional Column |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID … opt_assay[1]_my_value … opt_global_another_value SML 1 … My value … some other value |
---- SMH ... opt_global_cv_value ... SML ... opt_global_cv_MS:1002217_decoy_peptide=null ... ---- |
4. Small Molecule Feature (SMF) Section
4.1. Element Details
4.1.1. SMF_ID
| ⚠️ Changed fields: Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A within file unique identifier for the small molecule feature. |
A within file unique identifier for the small molecule feature. |
Type |
Integer |
Integer |
Mandatory |
— |
True |
Nullable |
False |
False |
Example |
SFH SMF_ID … SMF 1 … SMF 2 … |
---- SFH ... SMF_ID ... SMF ... 1 ... ---- |
4.1.2. SME_ID_REFS
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
References to the identification evidence (SME elements) via referencing SME_ID values. Multiple values MAY be provided as a “{vbar}” separated list to indicate ambiguity in the identification or to indicate that different types of data supported the identifiction (see SME_ID_REF_ambiguity_code). For the case of a consensus approach where multiple adduct forms are used to infer the SML ID, different features should just reference the same SME_ID value(s). |
References to the identification evidence (SME elements) via referencing SME_ID values. Multiple values MAY be provided as a {vbar} separated list to indicate ambiguity in the identification or to indicate that different types of data supported the identifiction (see sme_id_ref_ambiguity_code). For the case of a consensus approach where multiple adduct forms are used to infer the SML ID, different features should just reference the same SME_ID value(s). |
Type |
{SME_ID} list |
Integer List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SFH SMF_ID SME_ID_REFS
SMF 1 5\{vbar}6\{vbar}12…
|
----
SFH ... SME_ID_REFS ...
SMF ... 5\{vbar}6\{vbar}12 ...
----
|
4.1.3. SME_ID_REF_ambiguity_code
| ⚠️ Changed fields: Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
If multiple values are given under SME_ID_REFS, one of the following codes MUST be provided. 1=Ambiguous identification; 2=Only different evidence streams for the same molecule with no ambiguity; 3=Both ambiguous identification and multiple evidence streams. If there are no or one value under SME_ID_REFs, this MUST be reported as null. |
If multiple values are given under SME_ID_REFS, one of the following codes MUST be provided. 1=Ambiguous identification; 2=Only different evidence streams for the same molecule with no ambiguity; 3=Both ambiguous identification and multiple evidence streams. If there are no or one value under SME_ID_REFs, this MUST be reported as null. |
Type |
Integer |
Integer |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SFH SMF_ID SME_ID_REFS SME_ID_REF_ambiguity_code
SMF 1 5\{vbar}6\{vbar}12… 1
|
---- SFH ... SME_ID_REF_ambiguity_code ... SMF ... 1 ... ---- |
4.1.4. adduct_ion
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The assumed classification of this molecule’s adduct ion after detection, following the general style in the 2013 IUPAC recommendations on terms relating to MS e.g. |
The assumed classification of this molecule’s adduct ion after detection, following the general style in the 2013 IUPAC recommendations on terms relating to MS e.g. [M+H]1+, [M+Na]1+, [M+NH4]1+, [M-H]1-, [M+Cl]1-. |
Type |
Regex |
String |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SFH SMF_ID … adduct_ion … SMF 1 … [M+H]+ … SMF 2 … [M+2Na]2+ … |
---- SFH ... adduct_ion ... SMF ... [M+H]1+ ... SMF ... [M+2Na]2+ ... ---- |
4.1.5. isotopomer
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
If de-isotoping has not been performed, then the isotopomer quantified MUST be reported here e.g. “+1”, “+2”, “13C peak” using CV terms, otherwise (i.e. for approaches where SMF rows are de-isotoped features) this MUST be null. |
If de-isotoping has not been performed, then the isotopomer quantified MUST be reported here e.g. “+1”, “+2”, “13C peak” using CV terms, otherwise (i.e. for approaches were SMF rows are de-isotoped features) this MUST be null. |
Type |
Parameter |
Parameter |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SFH SMF_ID … isotopomer … SMF 1 … [MS,MS:1002957,”isotopomer MS peak”,”13C peak”]… |
---- SFH ... isotopomer ... SMF ... [MS,MS:1002957,”isotopomer MS peak”,”13C peak”] ... ---- |
4.1.6. exp_mass_to_charge
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The experimental mass/charge value for the feature, by default assumed to be the mean across assays or a representative value. For approaches that report isotopomers as SMF rows, then the m/z of the isotopomer MUST be reported here. |
The experimental mass/charge value for the feature, by default assumed to be the mean across assays or a representative value. For approaches that report isotopomers as SMF rows, then the m/z of the isotopomer MUST be reported here. |
Type |
Double |
Double |
Mandatory |
— |
True |
Nullable |
False |
False |
Example |
SFH SMF_ID … exp_mass_to_charge … SMF 1 … 1234.5 … |
---- SFH ... exp_mass_to_charge ... SMF ... 1234.5 ... ---- |
4.1.7. charge
| ⚠️ Changed fields: Description, Mandatory, Nullable, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The feature’s charge value using positive integers both for positive and negative polarity modes. Is nullable in the SMF table but if identification is precised the charge is expected to expected to be known. |
The feature’s charge value using positive integers both for positive and negative polarity modes. |
Type |
Integer |
Integer |
Mandatory |
— |
False |
Nullable |
True |
False |
Example |
SFH SMF_ID … charge … SMF 1 … 1 … |
---- SFH ... charge ... SMF ... 1 ... ---- |
4.1.8. retention_time_in_seconds
| ⚠️ Changed fields: Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The apex of the feature on the retention time axis, in a Master or aggregate MS run. Retention time MUST be reported in seconds. Retention time values for individual MS runs (i.e. before alignment) MAY be reported as optional columns. Retention time SHOULD only be null in the case of direct infusion MS or other techniques where a retention time value is absent or unknown. Relative retention time or retention time index values MAY be reported as optional columns, and could be considered for inclusion in future versions of mzTab as appropriate. |
The apex of the feature on the retention time axis, in a Master or aggregate MS run. Retention time MUST be reported in seconds. Retention time values for individual MS runs (i.e. before alignment) MAY be reported as optional columns. Retention time SHOULD only be null in the case of direct infusion MS or other techniques where a retention time value is absent or unknown. Relative retention time or retention time index values MAY be reported as optional columns, and could be considered for inclusion in future versions of mzTab as appropriate. |
Type |
Double |
Double |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SFH SMF_ID … retention_time_in_seconds … SMF 1 … 1345.7 … |
---- SFH ... retention_time_in_seconds ... SMF ... 1345.7 ... ---- |
4.1.9. retention_time_in_seconds_start
| ⚠️ Changed fields: Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The start time of the feature on the retention time axis, in a Master or aggregate MS run. Retention time MUST be reported in seconds. Retention time start and end SHOULD only be null in the case of direct infusion MS or other techniques where a retention time value is absent or unknown and MAY be reported in optional columns. |
The start time of the feature on the retention time axis, in a Master or aggregate MS run. Retention time MUST be reported in seconds. Retention time start and end SHOULD only be null in the case of direct infusion MS or other techniques where a retention time value is absent or unknown and MAY be reported in optional columns. |
Type |
Double |
Double |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SFH SMF_ID … retention_time_in_seconds_start … SMF 1 … 1327.0 … |
---- SFH ... retention_time_in_seconds_start ... SMF ... 1327 ... ---- |
4.1.10. retention_time_in_seconds_end
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The end time of the feature on the retention time axis, in a Master or aggregate MS run. Retention time MUST be reported in seconds. Retention time start and end SHOULD only be null in the case of direct infusion MS or other techniques where a retention time value is absent or unknown and MAY be reported in optional columns.. |
The end time of the feature on the retention time axis, in a Master or aggregate MS run. Retention time MUST be reported in seconds. Retention time start and end SHOULD only be null in the case of direct infusion MS or other techniques where a retention time value is absent or unknown and MAY be reported in optional columns. |
Type |
Double |
Double |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SFH SMF_ID … retention_time_in_seconds_end … SMF 1 … 1327.8 … |
---- SFH ... retention_time_in_seconds_end ... SMF ... 1327.8 ... ---- |
4.1.11. abundance_assay[1-n]
| ⚠️ Changed fields: Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The feature’s abundance in every assay described in the metadata section MUST be reported. Null or zero values may be reported as appropriate. |
The feature’s abundance in every assay described in the metadata section MUST be reported. Null or zero values may be reported as appropriate. |
Type |
Double |
Double List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SMH SML_ID … abundance_assay[1] … SMF 1 … 38648 … |
---- SFH ... abundance_assay ... SMF ... 38648 ... ---- |
4.1.12. opt_{identifier}_*
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Additional columns can be added to the end of the small molecule feature table. These column headers MUST start with the prefix “opt_” followed by the {identifier} of the object they reference: assay, study variable, MS run or “global” (if the value relates to all replicates). Column names MUST only contain the following characters: ‘A’-‘Z’, ‘a’-‘z’, ‘0’-‘9’, ‘’, ‘-’, ‘[’, ‘]’, and ‘:’. CV parameter accessions MAY be used for optional columns following the format: opt_{identifier}_cv_{accession}_{parameter name}. Spaces within the parameter’s name MUST be replaced by ‘’. |
Additional columns can be added to the end of the small molecule feature table. These column headers MUST start with the prefix “opt_” followed by the {identifier} of the object they reference: assay, study variable, MS run or “global” (if the value relates to all replicates). Column names MUST only contain the following characters: 'A'-'Z', 'a'-'z', '0'-'9', '', '-', '[', ']', and ':'. CV parameter accessions MAY be used for optional columns following the format: opt{identifier}_cv_{accession}_parameter name}. Spaces within the parameter’s name MUST be replaced by '_'. |
Type |
Column |
Optional Column |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SFH SMF_ID … opt_assay[1]_my_value … opt_global_another_value SMF 1 … My value … some other value |
---- SFH ... opt_global_cv_value ... SMF ... opt_assay[1]_my_value=My value ... SMF ... opt_global_another_value=some other value ... ---- |
5. Small Molecule Evidence (SME) Section
5.1. Element Details
5.1.1. SME_ID
| ⚠️ Changed fields: Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A within file unique identifier for the small molecule evidence result. |
A within file unique identifier for the small molecule evidence result. |
Type |
Integer |
Integer |
Mandatory |
— |
True |
Nullable |
False |
False |
Example |
SEH SME_ID … SME 1 … |
---- SEH ... SME_ID ... SME ... 1 ... ---- |
5.1.2. evidence_input_id
| ⚠️ Changed fields: Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A within file unique identifier for the input data used to support this identification e.g. fragment spectrum, RT and m/z pair, isotope profile that was used for the identification process, to serve as a grouping mechanism, whereby multiple rows of results from the same input data share the same ID. The identifiers may be human readable but should not be assumed to be interpretable. For example, if fragmentation spectra have been searched then the ID may be the spectrum reference, or for accurate mass search, the ms_run[2]:458.75. |
A within file unique identifier for the input data used to support this identification e.g. fragment spectrum, RT and m/z pair, isotope profile that was used for the identification process, to serve as a grouping mechanism, whereby multiple rows of results from the same input data share the same ID. The identifiers may be human readable but should not be assumed to be interpretable. For example, if fragmentation spectra have been searched then the ID may be the spectrum reference, or for accurate mass search, the ms_run[2]:458.75. |
Type |
String |
String |
Mandatory |
— |
True |
Nullable |
False |
False |
Example |
SEH SME_ID evidence_input_id … SME 1 ms_run[1]:mass=278.65;rt=376.5 SME 2 ms_run[1]:mass=278.65;rt=376.5 SME 3 ms_run[1]:mass=278.65;rt=376.5 (in this example three identifications were made from the same accurate mass/RT library search) |
---- SEH ... evidence_input_id ... SME ... ms_run[1]:mass=278.65;rt=376.5 ... ---- |
5.1.3. database_identifier
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The putative identification for the small molecule sourced from an external database, using the same prefix specified in database[1-n]-prefix. |
The putative identification for the small molecule sourced from an external database, using the same prefix specified in database[1-n]-prefix. This could include additionally a chemical class or an identifier to a spectral library entity, even if its actual identity is unknown. For the “no database” case, 'null' must be used. The unprefixed use of 'null' is prohibited for any other case. If no putative identification can be reported for a particular database, it MUST be reported as the database prefix followed by null. |
Type |
String |
String |
Mandatory |
— |
True |
Nullable |
True |
True |
Example |
SEH SME_ID identifier … SME 1 CID:00027395 … SME 2 HMDB:HMDB12345 … SME 3 CID:null … |
---- SEH ... database_identifier ... SME ... CID:00027395 ... ---- |
5.1.4. chemical_formula
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The chemical formula of the identified compound e.g. in a database, assumed to match the theoretical mass to charge (in some cases this will be the derivatized form, including adducts and protons). |
The chemical formula of the identified compound e.g. in a database, assumed to match the theoretical mass to charge (in some cases this will be the derivatized form, including adducts and protons). This should be specified in Hill notation (EA Hill 1900), i.e. elements in the order C, H and then alphabetically all other elements. Counts of one may be omitted. Elements should be capitalized properly to avoid confusion (e.g., “CO” vs. “Co”). The chemical formula reported should refer to the neutral form. Charge state is reported by the charge field. Example N-acetylglucosamine would be encoded by the string “C8H15NO6” |
Type |
String |
String |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SEH SME_ID … chemical_formula … SME 1 … C17H20N4O2 … |
---- SEH ... chemical_formula ... SME ... C17H20N4O2 ... ---- |
5.1.5. smiles
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The potential molecule’s structure in the simplified molecular-input line-entry system (SMILES) for the small molecule. |
The potential molecule’s structure in the simplified molecular-input line-entry system (SMILES) for the small molecule. |
Type |
String |
String |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SEH SME_ID … chemical_formula smiles … SML 1 … C17H20N4O2 C1=CC=C(C=C1)CCNC(=O)CCNNC(=O)C2=CC=NC=C2 … |
---- SEH ... smiles ... SME ... C1=CC=C(C=C1)CCNC(=O)CCNNC(=O)C2=CC=NC=C2 ... ---- |
5.1.6. inchi
| ⚠️ Changed fields: Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A standard IUPAC International Chemical Identifier (InChI) for the given substance. |
A standard IUPAC International Chemical Identifier (InChI) for the given substance. |
Type |
String |
String |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SEH SME_ID … chemical_formula … inchi … SML 1 … C17H20N4O2 … InChI=1S/C17H20N4O2/c22-16(19-12-6-14-4-2-1-3-5-14)9-13-20-21-17(23)15-7-10-18-11-8-15/h1-5,7-8,10-11,20H,6,9,12-13H2,(H,19,22)(H,21,23) … |
---- SEH ... inchi ... SME ... InChI=1S/C17H20N4O2/c22-16(19-12-6-14-4-2-1-3-5-14)9-13-20-21-17(23)15-7-10-18-11-8-15/h1-5,7-8,10-11,20H,6,9,12-13H2,(H,19,22)(H,21,23) ... ---- |
5.1.7. chemical_name
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The small molecule’s chemical/common name, or general description if a chemical name is unavailable. |
The small molecule’s chemical/common name, or general description if a chemical name is unavailable. |
Type |
String |
String |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SEH SME_ID … chemical_name … SML 1 … N-(2-phenylethyl)-3-[2-(pyridine-4-carbonyl)hydrazinyl]propanamide… |
---- SEH ... chemical_name ... SME ... N-(2-phenylethyl)-3-[2-(pyridine-4-carbonyl)hydrazinyl]propanamide ... ---- |
5.1.8. uri
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
A URI pointing to the small molecule’s entry in a database (e.g., the small molecule’s HMDB, Chebi or KEGG entry). |
A URI pointing to the small molecule’s entry in a database (e.g., the small molecule’s HMDB, Chebi or KEGG entry). |
Type |
URI |
URI |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SEH SME_ID … uri … SME 1 … http://www.hmdb.ca/metabolites/HMDB00054 |
---- SEH ... uri ... SME ... http://www.hmdb.ca/metabolites/HMDB00054 ... ---- |
5.1.9. derivatized_form
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
If a derivatized form has been analysed by MS, then the functional group attached to the molecule should be reported here using suitable userParam or CV terms as appropriate. |
The derivatized form of the small molecule, if the identification was based on a specific derivative (e.g. 2 TMS). This MUST be specified using CV terms (where possible) otherwise “null”. |
Type |
Parameter |
Parameter |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
COM This example shows a triple substitution with a TMS group (3TMS) SMH database_identifier … derivatized_form … SML CID:00027395 … [CHEBI, CHEBI:51088, trimethylsilyl group, 3] … |
---- SEH ... derivatized_form ... SME ... [CHEBI, CHEBI:51088, trimethylsilyl group, 3] ... ---- |
5.1.10. adduct_ion
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The assumed classification of this molecule’s adduct ion after detection, following the general style in the 2013 IUPAC recommendations on terms relating to MS e.g. |
The assumed classification of this molecule’s adduct ion after detection, following the general style in the 2013 IUPAC recommendations on terms relating to MS e.g. [M+H]1+, [M+Na]1+, [M+NH4]1+, [M-H]1-, [M+Cl]1-. If the adduct classification is ambiguous with regards to identification evidence it MAY be null. |
Type |
Regex |
Regex |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SEH SME_ID … adduct_ion … SME 1 … [M+H]+ … SME 2 … [M+2Na]2+ … OR (for negative mode): SME 1 … [M-H]- … SME 2 … [M+Cl]- … |
---- SEH ... adduct_ion ... SME ... [M+H]+ ... ---- |
5.1.11. exp_mass_to_charge
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The experimental mass/charge value for the precursor ion. If multiple adduct forms have been combined into a single identification event/search, then a single value e.g. for the protonated form SHOULD be reported here. |
The experimental mass/charge value for the precursor ion. If multiple adduct forms have been combined into a single identification event/search, then a single value e.g. for the protonated form SHOULD be reported here. |
Type |
Double |
Double |
Mandatory |
— |
True |
Nullable |
False |
False |
Example |
SEH SME_ID … exp_mass_to_charge … SME 1 … 1234.5 … |
---- SEH ... exp_mass_to_charge ... SME ... 1234.5 ... ---- |
5.1.12. charge
| ⚠️ Changed fields: Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The small molecule evidence’s charge value using positive integers both for positive and negative polarity modes. |
The small molecule evidence’s charge value using positive integers both for positive and negative polarity modes. |
Type |
Integer |
Integer |
Mandatory |
— |
True |
Nullable |
False |
False |
Example |
SEH SME_ID … charge … SME 1 … 1 … |
---- SEH ... charge ... SME ... 1 ... ---- |
5.1.13. theoretical_mass_to_charge
| ⚠️ Changed fields: Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The theoretical mass/charge value for the small molecule or the database mass/charge value (for a spectral library match). |
The theoretical mass/charge value for the small molecule or the database mass/charge value (for a spectral library match). |
Type |
Double |
Double |
Mandatory |
— |
True |
Nullable |
False |
False |
Example |
SEH SME_ID … theoretical_mass_to_charge … SME 1 … 1234.71 … |
---- SEH ... theoretical_mass_to_charge ... SME ... 1234.71 ... ---- |
5.1.14. spectra_ref
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Reference to a spectrum in a spectrum file, for example a fragmentation spectrum has been used to support the identification. If a separate spectrum file has been used for fragmentation spectrum, this MUST be reported in the metadata section as additional ms_runs. The reference must be in the format ms_run[1-n]:{SPECTRA_REF} where SPECTRA_REF MUST follow the format defined in 5.2 (including references to chromatograms where these are used to inform identification). Multiple spectra MUST be referenced using a “{vbar}” delimited list for the (rare) cases in which search engines have combined or aggregated multiple spectra in advance of the search to make identifications. |
Reference to a spectrum in a spectrum file, for example a fragmentation spectrum has been used to support the identification. If a separate spectrum file has been used for fragmentation spectrum, this MUST be reported in the metadata section as additional ms_runs. The reference must be in the format ms_run[1-n]:{SPECTRA_REF} where SPECTRA_REF MUST follow the format defined in 5.2 (including references to chromatograms where these are used to inform identification). Multiple spectra MUST be referenced using a {vbar} delimited list for the (rare) cases in which search engines have combined or aggregated multiple spectra in advance of the search to make identifications. If a fragmentation spectrum has not been used, the value should indicate the ms_run to which is identification is mapped e.g. “ms_run[1]”. |
Type |
String List |
String List |
Mandatory |
— |
True |
Nullable |
False |
False |
Example |
SEH SME_ID … spectra_ref … SME 1 … ms_run[1]:index=5 … |
----
SEH ... spectra_ref ...
SME ... ms_run[1]:index=5\{vbar}ms_run[2]:index=3 ...
----
|
5.1.15. identification_method
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The database search, search engine or process that was used to identify this small molecule e.g. the name of software, database or manual curation etc. If manual validation has been performed quality, the following CV term SHOULD be used: "quality estimation by manual validation" MS:1001058. |
The search engine or algorithm used for the identification. This SHOULD be specified using CV terms. |
Type |
Parameter |
Parameter |
Mandatory |
— |
True |
Nullable |
False |
False |
Example |
SEH SME_ID … identification_method… SME 1 … [MS, MS:1001477, SpectraST,] … |
---- SEH ... identification_method ... SME ... [MS, MS:1001477, SpectraST,] ... ---- |
5.1.16. ms_level
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The highest MS level used to inform identification e.g. MS1 (accurate mass only) = “ms level=1” or from an MS2 fragmentation spectrum = “ms level=2”. For direct fragmentation or data independent approaches where fragmentation data is used, appropriate CV terms SHOULD be used . |
The MS level of the spectrum used for the identification. This SHOULD be specified using CV terms. |
Type |
Parameter |
Parameter |
Mandatory |
— |
True |
Nullable |
False |
False |
Example |
SEH SME_ID … ms_level … SME 1 … [MS, MS:1000511, ms level, 2] … |
---- SEH ... ms_level ... SME ... [MS, MS:1000511, ms level, 2] ... ---- |
5.1.17. id_confidence_measure[1-n]
| ⚠️ Changed fields: Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Any statistical value or score for the identification. The metadata section reports the type of score used, as id_confidence_measure[1-n] of type Param. |
Any statistical value or score for the identification. The metadata section reports the type of score used, as id_confidence_measure[1-n] of type Param. |
Type |
Double |
Double List |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
MTD id_confidence_measure[1] [MS, MS:1001419, SpectraST:discriminant score F,] … SEH SME_ID … id_confidence_measure[1] … SME 1 … 0.7 … |
---- SEH ... id_confidence_measure ... SME ... 0.7 ... ---- |
5.1.18. rank
| ⚠️ Changed fields: Description, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
The rank of this identification from this approach as increasing integers from 1 (best ranked identification). Ties (equal score) are represented by using the same rank – defaults to 1 if there is no ranking system used. |
The rank of this identification from this approach as increasing integers from 1 (best ranked identification). Ties (equal score) are represented by using the same rank - defaults to 1 if there is no ranking system used. |
Type |
Integer |
Integer |
Mandatory |
— |
True |
Nullable |
False |
False |
Example |
SEH SME_ID … rank … SME 1 … 1 … |
---- SEH ... rank ... SME ... 1 ... ---- |
5.1.19. opt_{identifier}_*
| ⚠️ Changed fields: Description, Type, Mandatory, Example |
| Field | v2.0 | v2.1 |
|---|---|---|
Description |
Additional columns can be added to the end of the small molecule evidence table. These column headers MUST start with the prefix “opt_” followed by the {identifier} of the object they reference: assay, study variable, MS run or “global” (if the value relates to all replicates). Column names MUST only contain the following characters: ‘A’-‘Z’, ‘a’-‘z’, ‘0’-‘9’, ‘’, ‘-’, ‘[’, ‘]’, and ‘:’. CV parameter accessions MAY be used for optional columns following the format: opt_{identifier}_cv_{accession}_{parameter name}. Spaces within the parameter’s name MUST be replaced by ‘’. |
Additional columns can be added to the end of the small molecule evidence table. These column headers MUST start with the prefix “opt_” followed by the {identifier} of the object they reference: assay, study variable, MS run or “global” (if the value relates to all replicates). Column names MUST only contain the following characters: 'A'-'Z', 'a'-'z', '0'-'9', '', '-', '[', ']', and ':'. CV parameter accessions MAY be used for optional columns following the format: opt{identifier}_cv_{accession}_{parameter name}. Spaces within the parameter’s name MUST be replaced by '_'. |
Type |
Column |
Optional Column |
Mandatory |
— |
False |
Nullable |
True |
True |
Example |
SEH SME_ID … opt_assay[1]_my_value … opt_global_another_value SML 1 … My value … some other value |
---- SEH ... opt_global_cv_value ... SME ... opt_assay[1]_my_value=My value ... SME ... opt_global_another_value=some other value ... ---- |