mzml-format-validation
License: restricted — no clear open-source license detected for the underlying tool; verify licensing before commercial use or redistribution.
Summary
Validate downloaded mzML files against the mzML XML schema to confirm structural integrity, presence of spectrum list, and indexed offset consistency before loading into analysis pipelines. This ensures data quality and compatibility with downstream spectrum access and metadata retrieval tools.
When to use
After downloading an mzML file from a remote repository (e.g., MetaboLights, MassIVE, GNPS) via USI resolution, before attempting to parse it into a spectrum container or visualization dashboard. Validation is essential when the source file integrity cannot be assumed or when the file will be used in production analysis workflows.
When NOT to use
- Input file is already loaded in memory as a spectrum object; re-validation of a parsed object is unnecessary.
- Input file comes from a trusted, validated local cache with documented provenance; skip validation if reproducibility does not depend on fresh verification.
- File format is not mzML (e.g., mzXML, NetCDF, Bruker .d); use format-specific validators instead.
Inputs
- mzML file (downloaded or local path)
- mzML schema definition (implicit in validator)
Outputs
- Validation result (pass/fail boolean or report)
- Error log or message (if validation fails)
- Validated mzML file ready for parsing (if validation passes)
How to apply
Parse the downloaded mzML file using a dedicated mzML validator tool (such as mzML indexer or pymzML parser) to check XML well-formedness, verify the presence and structure of the spectrum list element, and confirm that indexed offset records match the actual byte positions of spectrum entries in the file. If validation fails (malformed XML, missing spectrum list, corrupted offsets), reject the file and re-download. Pass only validated files to downstream spectrum container constructors. The validation step is grounded in the USI resolution workflow where file integrity directly impacts spectrum loading reliability.
Related tools
- pymzML (Parse and validate mzML XML structure; confirm spectrum list presence and indexed offset integrity)
- mzML indexer (Validate mzML schema compliance and index offset correctness)
- GNPS LCMS Visualization Dashboard (Consume validated mzML files for spectrum visualization and XIC extraction) — https://github.com/Wang-Bioinformatics-Lab/GNPS_LCMSDashboard
Examples
from pymzml.run import Reader; run = Reader('QC07.mzML'); spectra = [s for s in run]; assert len(spectra) > 0, 'No spectra found'
Evaluation signals
- Validator returns no XML parsing errors; file structure conforms to mzML schema.
- Spectrum list element is present and contains at least one spectrum entry with valid index references.
- Indexed byte offsets in the mzML index match actual file positions of spectrum elements when spot-checked.
- File can be successfully loaded into a pymzML container without exceptions; spectrum metadata and scan numbers are accessible.
- Validated file produces consistent chromatogram and spectrum data when visualized in the GNPS LCMS Dashboard or equivalent viewer.
Limitations
- Validation only confirms syntactic and structural correctness; does not verify semantic correctness (e.g., whether m/z values are physically plausible or whether retention times are monotonic).
- Some validators may not detect all edge cases of corrupt index offsets in very large mzML files; manual spot-checking of index entries is recommended for critical workflows.
- Validation performance may degrade on very large files (>1 GB); consider streaming or sampling-based validation for production pipelines with strict latency requirements.
Evidence
- [other] Validate the downloaded file against mzML schema using an mzML validator (e.g., mzML indexer or pymzML parser) to confirm XML structure, presence of spectrum list, and indexed offset integrity.: "Validate the downloaded file against mzML schema using an mzML validator (e.g., mzML indexer or pymzML parser) to confirm XML structure, presence of spectrum list, and indexed offset integrity."
- [other] Load the validated mzML file into an mzML spectrum container (e.g., pymzML object or equivalent data structure) to enable downstream spectrum access and metadata retrieval.: "Load the validated mzML file into an mzML spectrum container (e.g., pymzML object or equivalent data structure) to enable downstream spectrum access and metadata retrieval."
1---2name: mzml-format-validation-23description: Use when after downloading an mzML file from a remote repository (e.g., MetaboLights, MassIVE, GNPS) via USI resolution, before attempting to parse it into a spectrum container or visualization dashboard.4license: CC-BY-4.05---67# mzml-format-validation89> **License: restricted** — no clear open-source license detected for the underlying tool; verify licensing before commercial use or redistribution. <!-- asb-license-banner -->10## Summary1112Validate downloaded mzML files against the mzML XML schema to confirm structural integrity, presence of spectrum list, and indexed offset consistency before loading into analysis pipelines. This ensures data quality and compatibility with downstream spectrum access and metadata retrieval tools.1314## When to use1516After downloading an mzML file from a remote repository (e.g., MetaboLights, MassIVE, GNPS) via USI resolution, before attempting to parse it into a spectrum container or visualization dashboard. Validation is essential when the source file integrity cannot be assumed or when the file will be used in production analysis workflows.1718## When NOT to use1920- Input file is already loaded in memory as a spectrum object; re-validation of a parsed object is unnecessary.21- Input file comes from a trusted, validated local cache with documented provenance; skip validation if reproducibility does not depend on fresh verification.22- File format is not mzML (e.g., mzXML, NetCDF, Bruker .d); use format-specific validators instead.2324## Inputs2526- mzML file (downloaded or local path)27- mzML schema definition (implicit in validator)2829## Outputs3031- Validation result (pass/fail boolean or report)32- Error log or message (if validation fails)33- Validated mzML file ready for parsing (if validation passes)3435## How to apply3637Parse the downloaded mzML file using a dedicated mzML validator tool (such as mzML indexer or pymzML parser) to check XML well-formedness, verify the presence and structure of the spectrum list element, and confirm that indexed offset records match the actual byte positions of spectrum entries in the file. If validation fails (malformed XML, missing spectrum list, corrupted offsets), reject the file and re-download. Pass only validated files to downstream spectrum container constructors. The validation step is grounded in the USI resolution workflow where file integrity directly impacts spectrum loading reliability.3839## Related tools4041- **pymzML** (Parse and validate mzML XML structure; confirm spectrum list presence and indexed offset integrity)42- **mzML indexer** (Validate mzML schema compliance and index offset correctness)43- **GNPS LCMS Visualization Dashboard** (Consume validated mzML files for spectrum visualization and XIC extraction) — https://github.com/Wang-Bioinformatics-Lab/GNPS_LCMSDashboard4445## Examples4647```48from pymzml.run import Reader; run = Reader('QC07.mzML'); spectra = [s for s in run]; assert len(spectra) > 0, 'No spectra found'49```5051## Evaluation signals5253- Validator returns no XML parsing errors; file structure conforms to mzML schema.54- Spectrum list element is present and contains at least one spectrum entry with valid index references.55- Indexed byte offsets in the mzML index match actual file positions of spectrum elements when spot-checked.56- File can be successfully loaded into a pymzML container without exceptions; spectrum metadata and scan numbers are accessible.57- Validated file produces consistent chromatogram and spectrum data when visualized in the GNPS LCMS Dashboard or equivalent viewer.5859## Limitations6061- Validation only confirms syntactic and structural correctness; does not verify semantic correctness (e.g., whether m/z values are physically plausible or whether retention times are monotonic).62- Some validators may not detect all edge cases of corrupt index offsets in very large mzML files; manual spot-checking of index entries is recommended for critical workflows.63- Validation performance may degrade on very large files (>1 GB); consider streaming or sampling-based validation for production pipelines with strict latency requirements.6465## Evidence6667- [other] Validate the downloaded file against mzML schema using an mzML validator (e.g., mzML indexer or pymzML parser) to confirm XML structure, presence of spectrum list, and indexed offset integrity.: "Validate the downloaded file against mzML schema using an mzML validator (e.g., mzML indexer or pymzML parser) to confirm XML structure, presence of spectrum list, and indexed offset integrity."68- [other] Load the validated mzML file into an mzML spectrum container (e.g., pymzML object or equivalent data structure) to enable downstream spectrum access and metadata retrieval.: "Load the validated mzML file into an mzML spectrum container (e.g., pymzML object or equivalent data structure) to enable downstream spectrum access and metadata retrieval."
HolobiomicsLab