This repository has been archived by the owner on Jul 27, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
jmzTab Messages
Noemi del Toro Ayllón edited this page Aug 5, 2015
·
3 revisions
These error messages are classified in two categories: 'Format Type' (reporting format problems) and 'Logical Type' (reporting errors related to the logical relationships among the different sections in a file).
The validation messages have a unique identifier are classified in three levels: Info, Warn and Error. All of them come from the notational conventions included in the specification document. This way, all the rules in the specification which use "MUST", "MUST NOT", "REQUIRED" as keywords, are defined at the Error level; the ones that use "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT" as keywords are defined at the Warn level. Finally, others keywords such as "RECOMMENDED", "MAY" and "OPTIONAL", are defined at the Info Level.
Code: | 1000 |
---|---|
Level: | Error |
Original: | "{0}" MUST start with [MTD, PRH, PRT, PEH, PEP, PSH, PSM, SMH, SML, COM] |
Cause: | Every line in an mzTab file MUST start with a three letter code identifying the type of line delimited by a Tab character. The three letter codes are as follows [MTD, PRH, PRT, PEH, PEP, PSH, PSM, SMH, SML, COM] |
Code: | 1001 |
Level: | Error |
Original: | The number of Data line items is "{0}", whereas the number of header line items count is "{1}". They MUST be the same. |
Cause: | The number of Data line items does not match with the number of Header line items. Normally, the user has not used the Unicode Horizontal Tab character (Unicode codepoint 0009) as the column delimiter, there is a file encoding error, or the user has not provided the definition of optional columns in the header line. |
Code: | 1002 |
Level: | Error |
Original: | "{0}" value "{1}" is not a valid element name, which is given by indicating the number in square brackets. |
Cause: | Indexed element structure like: element_nameid-element_property. "id" and "-element_property" are optional. |
Code: | 1003 |
Level: | Error |
Original: | Optional Column "{0}" is not a valid abundance column format. |
Cause: | Only protein, peptide and small molecule sections can allow to have abundance columns. The column name psm_abundance_XXX is not correct.. |
Code: | 1004 |
Level: | Error |
Original: | Mandatory column "{0}" are required on the header line. |
Cause: | Check the mandatory columns (e.g. header name). All column labels and field names are case-sensitive. The column delimiter is the Unicode Horizontal Tab character. |
Code: | 1005 |
Level: | Error |
Original: | Optional column headers "{0}" are not allowed to be displayed in "{1}" line. |
Cause: | Only following ms_run optional columns allowed to be displayed in the header line: Protein header optional columns num_psms_ms_run[1-n], num_peptides_distinct_ms_run[1-n], num_peptides_unique_ms_run[1-n], Peptide header optional column search_engine_score_ms_run[1-n] and Small molecule optional column search_engine_score_ms_run[1-n]. |
Code: | 1007 |
Level: | Error |
Original: | Optional CV parameter column headers "{0}" format is not correct. |
Cause: | Optional column headers MUST start with the prefix "opt_". 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_cv{accession}{parameter name}. {parameter_name} can not set to 'null'. Spaces within the parameter's name MUST be replaced by ''. This is an optional column, and MAY be added at the right of the table._ |
Code: | 1008 |
Level: | Error |
Original: | "{0}" should have three parts, which are split by a Tab char. |
Cause: | MTD line including three parts, which are split by a Tab char. "MTD {defineLabel} {valueLabel}". Each of them should not be empty. |
Code: | 1009 |
Level: | Error |
Original: | Metadata define label "{0}" can not be recognized. |
Cause: | MTD defineLabel should include "{element}([{id}])-{property}", which is split by "-" char. |
Code: | 1010 |
Level: | Error |
Original: | "{0}" value "{1}" should be 'Complete' or 'Summary'. |
Cause: | The results included in an mzTab file can be reported in two ways: 'Complete' (when results for each assay/replicate are included) and 'Summary', when only the most representative results are reported. |
Code: | 1011 |
Level: | Error |
Original: | "{0}" value "{1}" should be 'Identification' or 'Quantification'. |
Cause: | The results included in an mzTab file MUST be flagged as 'Identification' or 'Quantification' - the latter encompassing approaches that are quantification only or quantification and identification. |
Code: | 1012 |
Level: | Error |
Original: | "{0}" value "{1}" is not a valid parameter. |
Cause: | Parameters are always reported as label, accession, name, value. Any field that is not available MUST be left empty, except 'name'. mzTab makes use of CV parameters. As mzTab is expected to be used in several experimental environments where parameters might not yet be available for the generated scores etc., all parameters can either be reported as CV parameters, or by user parameters that only contain a name and a value. In the case when the name of the param contains commas, quotes MUST be added to avoid problems with the parsing: [label, accession, "first part of the param name , second part of the name", value]. |
Code: | 1013 |
Level: | Error |
Original: | "{0}" value "{1}" is not a valid list of parameters. |
Cause: | If multiple parameters are given for a given step, these should be separated by a " |
Code: | 1014 |
Level: | Error |
Original: | "{0}" value "{1}" is not a valid publication. |
Cause: | PubMed ids must be prefixed by "pubmed:", DOIs by "doi:". Multiple identifiers MUST be separated by " |
Code: | 1015 |
Level: | Error |
Original: | "{0}" value "{1}" is not a valid URI. |
Cause: | A URI pointing to the unit's source data, (e.g. a PRIDE experiment or a PeptideAtlas build). For example, "MTD PRIDE_1234-uri http://www.ebi.ac.uk/pride/url/to/experiment". |
Code: | 1016 |
Level: | Error |
Original: | "{0}" value "{1}" is not a valid URL. |
Cause: | |
Code: | 1017 |
Level: | Error |
Original: | "{0}" value "{1}" is not a valid e-mail address. |
Cause: | A e-mail like userName@serverName |
Code: | 1018 |
Level: | Error |
Original: | Column "{0}" value "{1}" is not a valid Integer value. |
Cause: | This is not an Integer. Thousand separators MUST NOT be used in mzTab files. If ratios are included and the denominator is zero, the "INF" value MUST be used. If the result leads to calculation errors (for example 0/0), this MUST be reported as "not a number" ("NaN"). |
Code: | 1019 |
Level: | Error |
Original: | Column "{0}" value "{1}" is not a valid Double value. |
Cause: | In mzTab files the dot (".") MUST be used as decimal separator. Thousand separators MUST NOT be used in mzTab files. If ratios are included and the denominator is zero, the "INF" value MUST be used. If the result leads to calculation errors (for example 0/0), this MUST be reported as "not a number" ("NaN"). |
Code: | 1020 |
Level: | Error |
Original: | Column "{0}" value "{1}" is not a valid Reliability value. The value should be 1..3 |
Cause: | The reliability of the given protein identification. This must be supplied by the resource and has to be one of the following values: 1: high reliability; 2: medium reliability; 3: poor reliability. |
Code: | 1021 |
Level: | Error |
Original: | =Column "{0}" value "{1}" is not valid string list. The split char is "{1}" |
Cause: | =If multiple String, they must be split using a char. |
Code: | 1022 |
Level: | Error |
Original: | Column "{0}" value "{1}" is not a valid list of Doubles. The split char is "{1}" |
Cause: | If multiple Double using a split char. |
Code: | 1023 |
Level: | Error |
Original: | Column "{0}" value "{1}" is not a valid modification list. |
Cause: | A comma delimited list of modifications found in the given protein/peptide/small molecule. Modifications or substitutions are modelled using a specific modification object with the following format: {position}{Parameter}-{Modification or Substitution identifier} |
Code: | 1024 |
Level: | Error |
Original: | Column "{0}" value "{1}" is not a valid list of GO (Gene Ontology) terms. |
Cause: | A ' |
Code: | 1025 |
Level: | Error |
Original: | Column "{0}" value "{1}" is not a valid Boolean (0/1). |
Cause: | Boolean (0/1). To report the results of a target-decoy search, decoy identifications MAY be labelled using the optional column "opt_global_cv_MS:1002217_decoy_peptide". The value of this column MUST be a Boolean (1/0). |
Code: | 1026 |
Level: | Error |
Original: | Column "{0}" value "{1}" is not a valid spectra reference, or the ms_run[1-n]-location is not defined in the metadata section. |
Cause: | The reference must be specified in the format ms_run[1-n]:{SPECTRA_REF}. Multiple spectra MUST be referenced using a ' |
Code: | 1027 |
Level: | Error |
Original: | Column "{0}" value "{1}" is not a valid CHEMMOD accession format. |
Cause: | CHEMMODS have the format CHEMMOD:+/-{chemical formula or m/z delta}. Valid CHEMMODS are for example "CHEMMOD:+NH4" or "CHEMMOD:-10.1098". Mass deltas MUST NOT be used for CHEMMODs if the delta can be expressed through a known chemical formula. |
Code: | 1028 |
Level: | Warn |
Original: | Column "{0}" value "{1}" do not use CV parameters. |
Cause: | A " |
Code: | 1029 |
Level: | Error |
Original: | Metadata value label "{0}" column name "{1}" cannot be found in the list of stable column names. |
Cause: | The format of the column label should be {column name}={Parameter defining the unit}. {Parameter defining the unit}, where Parameter has the format of a Param. |
Code: | 2000 |
Level: | Error |
Original: | Column "{0}" is an empty cell, or the current column cannot use "null". |
Cause: | In the table-based sections (protein, peptide, psm, and small molecule) there MUST NOT be any empty cells. Missing values MUST be reported using "null". |
Code: | 2001 |
Level: | Warn |
Original: | Column "{0}" field value does not allow a "null" value. |
Cause: | Some kind of field value can not allow a "null" or empty value. In general, "null" values SHOULD not be given within any column of a "Complete" file. |
Code: | 2002 |
Level: | Error |
Original: | current line belongs to "{0}" section, "{1}" line can not be displayed here. |
Cause: | mzTab line including five main sections: metadata, protein, peptide, psm, small molecule. Every section in an mzTab file MUST only occur once (if present). The line order MUST be the following one: metadata lines should be displayed first, then the protein header, protein, peptide header, peptide, psm header, psm, small molecule header, and small molecule. |
Code: | 2003 |
Level: | Error |
Original: | header line "{0}" can only occur once! |
Cause: | Each table based section (protein, peptide, small molecule) MUST start with the corresponding header line. These header lines MUST only occur once in the document since each section also MUST only occur once. |
Code: | 2004 |
Level: | Error |
Original: | current line "{0}" is a data line, the corresponding header line has not been defined yet. |
Cause: | Each table based section (protein, peptide, small molecule) MUST start with the corresponding header line. These header lines MUST only occur once in the document since each section also MUST only occur once. |
Code: | 2005 |
Level: | Error |
Original: | Optional column header "{0}" ms_run[1-n] should be defined in the metadata section first. |
Cause: | Protein header optional columns num_psms_ms_run[1-n], num_peptides_distinct_ms_run[1-n], num_peptides_unique_ms_run[1-n], Peptide header optional column search_engine_score_ms_run[1-n] and Small molecule optional column search_engine_score_ms_run[1-n]. In all of them, ms_run[1-n] should be defined in the metadata section first. |
Code: | 2006 |
Level: | Error |
Original: | Abundance optional column header "{0}" assay[1-n] should be defined in the metadata section first. |
Cause: | Protein abundance optional columns protein_abundance_assay[1-n], Peptide abundance optional column peptide_abundance_assay[1-n] and Small molecule abundance optional column smallmolecule_abundance_assay[1-n]. In all of them, assay[1-n] should be defined in the metadata section first. |
Code: | 2007 |
Level: | Error |
Original: | Abundance optional column header "{0}" study_variable[1-n] should be defined in the metadata section first. |
Cause: | Protein abundance optional columns protein_abundance_study_variable[1-n], protein_abundance_stdev_study_variable[1-n], protein_abundance_std_error_study_variable[1-n], Peptide abundance optional column peptide_abundance_study_variable[1-n], peptide_abundance_stdev_study_variable[1-n], peptide_abundance_std_error_study_variable[1-n] and Small molecule abundance optional column smallmolecule_abundance_study_variable[1-n], smallmolecule_abundance_stdev_study_variable[1-n], smallmolecule_abundance_std_error_study_variable[1-n]. In all of them, study_variable[1-n] should be defined in the metadata section first. |
Code: | 2008 |
Level: | Error |
Original: | "{0}" MUST be included in the metadata section when 'mzTab-mode' is "{1}" and 'mzTab-type' is "{2}". |
Cause: | Reference specification 5.5 |
Code: | 2009 |
Level: | Error |
Original: | "{0}" MUST be included in the header line when 'mzTab-mode' is "{1}" and 'mzTab-type' is "{2}". |
Cause: | Reference specification 5.5 |
Code: | 2010 |
Level: | Error |
Original: | "{0}" duplicate defined in the metadata section. |
Cause: | mzTab-ID, title, description, false_discovery_rate, fixed_mode, variable_mode, quantification_method, protein-quantification_unit, peptide-quantification_unit, small_molecule-quantification_unit. All of them only can only be displayed once in the metadata section. |
Code: | 2011 |
Level: | Error |
Original: | Column "{0}" value "{1}" is a duplicate. |
Cause: | The accession of the protein in the source database. A protein accession MUST be unique within one mzTab file. If different quantification values are required for the same underlying accession, for example if differentially modified forms of a protein have been quantified, a suitable suffix SHOULD be appended to the accession. |
Code: | 2012 |
Level: | Error |
Original: | "{0}" should be defined when assays and study variables are reported in the metadata section. |
Cause: | If both assays and study variables are reported in an mzTab file, the references to assays and study variables are MANDATORY. |
Code: | 2013 |
Level: | Error |
Original: | Column "{0}" value "{1}" is not a valid protein coverage value. It should be between 0 and 1. |
Cause: | A value between 0 and 1 defining the protein coverage |
Code: | 2014 |
Level: | Error |
Original: | "{0}" id number "{1}" should be a number, and the value should be greater than 0. |
Cause: | In mztab, multiple members are numbered 1..n, for example: Multiple sample processing are numbered sample_processing1, sample_processing2 |
Code: | 2015 |
Level: | Error |
Original: | Column "{0}" include a terminal modification "{1}", and its position must be between 0 and sequence "{2}".length + 1. |
Cause: | Terminal modifications MUST be reported at position 0 or protein size + 1 respectively. |
Code: | 2016 |
Level: | Warn |
Original: | Column "{0}" value "{1}" is kind of CHEMMODS. Their use is not recommended. |
Cause: | For proteins and peptides, modifications SHOULD be reported using either UNIMOD or PSI-MOD. As these two ontologies/CVs are not applicable to small molecules, so-called CHEMMODs can also be defined. CHEMMODs MUST NOT be used if the modification can be reported using a PSI-MOD or UNIMOD accession. Mass deltas MUST NOT be used for CHEMMODs if the delta can be expressed through a known chemical formula. |
Code: | 2017 |
Level: | Error |
Original: | Column "{0}" value "{1}" is not an original, unaltered amino acid sequence. |
Cause: | It is possible to report substitutions of amino acids using SUBST:{amino acid}. In these cases, the "sequence" column MUST contain the original, unaltered sequence. |
Code: | 2018 |
Level: | Warn |
Original: | Software parameter "{0}" does not contain version information. |
Cause: | The parameter's value SHOULD contain the software's version. The order (numbering) should reflect the order in which the tools were used. |
Code: | 2019 |
Level: | Error |
Original: | Missing abundance column "{0}" in the header line. |
Cause: | XXXX_abundance_study_variable[1-n], XXXX_abundance_stdev_study_variable[1-n], XXXX_abundance_std_error_study_variable[1-n] should be displayed together, the order cannot change either. |
Code: | 2020 |
Level: | Error |
Original: | Abundance columns "{0}", "{1}", "{2}" study_variable id number should be the same. |
Cause: | XXXX_abundance_study_variable[1-n], XXXX_abundance_stdev_study_variable[1-n], XXXX_abundance_std_error_study_variable[1-n] should have the same study_variableid number. |
Code: | 2021 |
Level: | Warn |
Original: | Column "{0}" value "{1}", "{2}" is "null". The use of "null" is allowed here however its use is discouraged. |
Cause: | If "spectra_ref" is present, the element "ms_run[1-n]-location" MUST be reported in the metadata section. Please check table 1 in the specification document. |
Code: | 2022 |
Level: | Warn |
Original: | Column "{0}" value "{1}" represents Ambiguity of modification position at the Protein level. Ambiguity of modification position MUST NOT be reported at the Protein level. |
Cause: | Ambiguity of modification position MUST NOT be reported at the Protein level. |
Code: | 2023 |
Level: | Warn |
Original: | "{0}" should be defined when assays are reported in the metadata section or if a PSM section is present in the file. |
Cause: | If assays are reported or if a PSM section is present in the file, these attributes are MANDATORY, since back references to the MS run MUST be provided in certain sections. If the actual location of the MS run is unknown, a place holder value SHOULD be inserted. |
Code: | 2024 |
Level: | Error |
Original: | Fixed modifications are not defined in the metadata section. |
Cause: | Fixed modifications should be defined in the metadata section, if PSM section is present. |
Code: | 2025 |
Level: | Error |
Original: | Variable modifications are not defined in the metadata section. |
Cause: | Variable modifications should be defined in the metadata section, if PSM section is present. |
Code: | 2026 |
Level: | Warn |
Original: | The existence of a Peptide Section line "{0}" is NOT RECOMMENDED in identification only files. |
Cause: | The existence of a Peptide section is NOT RECOMMENDED to be used in identification only files. |
Code: | 2027 |
Level: | Error |
Original: | If mzTab-type is "Quantification", then at least one section with {protein |
Code: | 2028 |
Level: | Error |
Original: | "{0}" contains duplicate identifier. |
Cause: | study_variable[1-n]-assay_refs and study_variable[1-n]-sample_refs MUST NOT contain duplicated identifier. |
- Introduction
- [Create Metadata](jmzTab Metadata)
- [Create Header and Fill Data](jmzTab Columns)
- [Utilities](jmzTab Utilities)
- [Warn/Error Messages](jmzTab Messages)
- JavaDoc
- [Release Notes](jmzTab Release Notes)