eic-file-format-generation
Summary
Export extracted ion chromatogram (EIC) data from JPA-aligned metabolomics features into standardized file formats (CSV, netCDF, mzML) with complete metadata headers. This skill enables downstream visualization, validation, and sharing of feature-level chromatographic traces across samples.
When to use
After completing MS2 annotation in the JPA metabolomics workflow, when you have aligned feature data (feature matrix with m/z, retention time, intensity, and sample assignments) and need to extract and export EIC traces for individual features or feature subsets for external validation, visualization, or archival.
When NOT to use
- Input is unaligned, single-sample feature data; EIC export is designed for multi-sample aligned features.
- Raw mass spectrometry data is not available or accessible; EIC extraction requires querying raw data at specified m/z values.
- Feature metadata lacks retention time boundaries (rtmin, rtmax) or m/z precision; export validation will fail without these fields.
Inputs
- aligned feature table (feature matrix with m/z, retention time, intensity, sample assignments)
- raw or processed mass spectrometry data (mzXML, mzML, or vendor format compatible with MS-Convert)
- feature metadata (m/z values, retention time boundaries, sample identifiers)
Outputs
- EIC export file (CSV, netCDF, or mzML format)
- EIC chromatogram objects (time vs. intensity traces)
- metadata-annotated EIC files with feature identifiers, m/z, retention time, and sample labels
How to apply
Load the aligned feature data and feature metadata (m/z, retention time, intensity, sample identifiers) from the JPA feature table into the R environment using JPA data structures. For each feature or user-specified subset, query the raw or processed mass spectrometry data at the feature's m/z value within a defined mass tolerance window (typically matching the ppm tolerance used in feature detection, e.g., 10 ppm). Extract ion chromatogram objects as time vs. intensity traces for each feature across selected samples. Generate EIC output by exporting the chromatogram data to JPA-supported file formats (CSV, netCDF, or mzML-compatible formats) with metadata headers including feature identifiers, m/z, retention time, and sample identifiers. Validate exported files for correct row/column structure, presence of all required metadata fields, and integrity before downstream use.
Related tools
- JPA (comprehensive metabolomics data processing platform that contains the EIC export module and provides feature alignment, annotation, and chromatogram generation functions) — https://github.com/HuanLab/JPA.git
- R (runtime environment for executing JPA functions and data structures for feature loading, metadata parsing, and EIC generation)
- XCMS (embedded peak picking and chromatographic alignment engine within JPA used to generate the aligned features and retention time calibration) — https://rdrr.io/bioc/xcms/man/
Evaluation signals
- Exported files contain all required metadata headers (feature ID, m/z, retention time, sample identifiers) and match the schema expected for the chosen format (CSV columns, netCDF dimensions, mzML XML structure).
- EIC chromatogram traces (time vs. intensity arrays) are non-empty and have valid numeric ranges for all selected features and samples; no NaN or infinite values are present.
- Row/column structure and row counts match the number of features exported and time points per chromatogram; file integrity passes format-specific validation tools (e.g., netCDF header checks, CSV row/column counts).
- m/z values in exported EICs match the feature table m/z ± mass tolerance window (e.g., ±10 ppm) and retention time boundaries align with rtmin/rtmax from input feature metadata.
- File size and content are consistent with expected data volume (number of features × number of samples × time points per chromatogram).
Limitations
- EIC export requires raw or processed mass spectrometry data to be available; if raw data is inaccessible or in unsupported formats (not MS-Convert compatible), chromatogram extraction will fail.
- Mass tolerance window (ppm) and retention time boundaries must be correctly specified; mismatched or overly broad tolerance windows may yield noisy or artifact-contaminated EICs.
- Export is designed for post-MS2 annotation features in the JPA workflow; features generated from MS2 recognition (MR) or targeted list extraction (TL) may have incomplete metadata and cause validation failures.
- File format compatibility depends on downstream tools; netCDF and mzML exports may require specialized parsers and may not be readable in standard spreadsheet applications.
Evidence
- [other] For each feature or user-specified subset, extract ion chromatograms by querying the raw or processed mass spectrometry data at the feature's m/z value within a defined mass tolerance window.: "For each feature or user-specified subset, extract ion chromatograms by querying the raw or processed mass spectrometry data at the feature's m/z value within a defined mass tolerance window."
- [other] Generate EIC chromatogram objects (time vs. intensity traces) for each feature across selected samples. Export EIC data to file format(s) supported by JPA (e.g., CSV, netCDF, or mzML-compatible formats) with metadata headers including feature identifiers, m/z, retention time, and sample identifiers.: "Export EIC data to file format(s) supported by JPA (e.g., CSV, netCDF, or mzML-compatible formats) with metadata headers including feature identifiers, m/z, retention time, and sample identifiers."
- [other] Validate output files for integrity, correct row/column structure, and presence of required metadata fields.: "Validate output files for integrity, correct row/column structure, and presence of required metadata fields."
- [readme] Part 8: Exporting EIC is positioned after Part 7: MS2 annotation in the workflow outline, confirming EIC export occurs post-annotation.: "Part 7: MS2 annotation ... Part 8: Exporting EIC"
- [other] Load aligned feature data (peaklist or feature matrix from prior JPA alignment step) into the R environment using JPA data structures.: "Load aligned feature data (peaklist or feature matrix from prior JPA alignment step) into the R environment using JPA data structures."
1---2name: eic-file-format-generation3description: Use when after completing MS2 annotation in the JPA metabolomics workflow, when you have aligned feature data (feature matrix with m/z, retention time, intensity, and sample assignments) and need to extract and export EIC traces for individual features or feature subsets for external validation.4license: CC-BY-4.05---67# eic-file-format-generation89## Summary1011Export extracted ion chromatogram (EIC) data from JPA-aligned metabolomics features into standardized file formats (CSV, netCDF, mzML) with complete metadata headers. This skill enables downstream visualization, validation, and sharing of feature-level chromatographic traces across samples.1213## When to use1415After completing MS2 annotation in the JPA metabolomics workflow, when you have aligned feature data (feature matrix with m/z, retention time, intensity, and sample assignments) and need to extract and export EIC traces for individual features or feature subsets for external validation, visualization, or archival.1617## When NOT to use1819- Input is unaligned, single-sample feature data; EIC export is designed for multi-sample aligned features.20- Raw mass spectrometry data is not available or accessible; EIC extraction requires querying raw data at specified m/z values.21- Feature metadata lacks retention time boundaries (rtmin, rtmax) or m/z precision; export validation will fail without these fields.2223## Inputs2425- aligned feature table (feature matrix with m/z, retention time, intensity, sample assignments)26- raw or processed mass spectrometry data (mzXML, mzML, or vendor format compatible with MS-Convert)27- feature metadata (m/z values, retention time boundaries, sample identifiers)2829## Outputs3031- EIC export file (CSV, netCDF, or mzML format)32- EIC chromatogram objects (time vs. intensity traces)33- metadata-annotated EIC files with feature identifiers, m/z, retention time, and sample labels3435## How to apply3637Load the aligned feature data and feature metadata (m/z, retention time, intensity, sample identifiers) from the JPA feature table into the R environment using JPA data structures. For each feature or user-specified subset, query the raw or processed mass spectrometry data at the feature's m/z value within a defined mass tolerance window (typically matching the ppm tolerance used in feature detection, e.g., 10 ppm). Extract ion chromatogram objects as time vs. intensity traces for each feature across selected samples. Generate EIC output by exporting the chromatogram data to JPA-supported file formats (CSV, netCDF, or mzML-compatible formats) with metadata headers including feature identifiers, m/z, retention time, and sample identifiers. Validate exported files for correct row/column structure, presence of all required metadata fields, and integrity before downstream use.3839## Related tools4041- **JPA** (comprehensive metabolomics data processing platform that contains the EIC export module and provides feature alignment, annotation, and chromatogram generation functions) — https://github.com/HuanLab/JPA.git42- **R** (runtime environment for executing JPA functions and data structures for feature loading, metadata parsing, and EIC generation)43- **XCMS** (embedded peak picking and chromatographic alignment engine within JPA used to generate the aligned features and retention time calibration) — https://rdrr.io/bioc/xcms/man/4445## Evaluation signals4647- Exported files contain all required metadata headers (feature ID, m/z, retention time, sample identifiers) and match the schema expected for the chosen format (CSV columns, netCDF dimensions, mzML XML structure).48- EIC chromatogram traces (time vs. intensity arrays) are non-empty and have valid numeric ranges for all selected features and samples; no NaN or infinite values are present.49- Row/column structure and row counts match the number of features exported and time points per chromatogram; file integrity passes format-specific validation tools (e.g., netCDF header checks, CSV row/column counts).50- m/z values in exported EICs match the feature table m/z ± mass tolerance window (e.g., ±10 ppm) and retention time boundaries align with rtmin/rtmax from input feature metadata.51- File size and content are consistent with expected data volume (number of features × number of samples × time points per chromatogram).5253## Limitations5455- EIC export requires raw or processed mass spectrometry data to be available; if raw data is inaccessible or in unsupported formats (not MS-Convert compatible), chromatogram extraction will fail.56- Mass tolerance window (ppm) and retention time boundaries must be correctly specified; mismatched or overly broad tolerance windows may yield noisy or artifact-contaminated EICs.57- Export is designed for post-MS2 annotation features in the JPA workflow; features generated from MS2 recognition (MR) or targeted list extraction (TL) may have incomplete metadata and cause validation failures.58- File format compatibility depends on downstream tools; netCDF and mzML exports may require specialized parsers and may not be readable in standard spreadsheet applications.5960## Evidence6162- [other] For each feature or user-specified subset, extract ion chromatograms by querying the raw or processed mass spectrometry data at the feature's m/z value within a defined mass tolerance window.: "For each feature or user-specified subset, extract ion chromatograms by querying the raw or processed mass spectrometry data at the feature's m/z value within a defined mass tolerance window."63- [other] Generate EIC chromatogram objects (time vs. intensity traces) for each feature across selected samples. Export EIC data to file format(s) supported by JPA (e.g., CSV, netCDF, or mzML-compatible formats) with metadata headers including feature identifiers, m/z, retention time, and sample identifiers.: "Export EIC data to file format(s) supported by JPA (e.g., CSV, netCDF, or mzML-compatible formats) with metadata headers including feature identifiers, m/z, retention time, and sample identifiers."64- [other] Validate output files for integrity, correct row/column structure, and presence of required metadata fields.: "Validate output files for integrity, correct row/column structure, and presence of required metadata fields."65- [readme] Part 8: Exporting EIC is positioned after Part 7: MS2 annotation in the workflow outline, confirming EIC export occurs post-annotation.: "Part 7: MS2 annotation ... Part 8: Exporting EIC"66- [other] Load aligned feature data (peaklist or feature matrix from prior JPA alignment step) into the R environment using JPA data structures.: "Load aligned feature data (peaklist or feature matrix from prior JPA alignment step) into the R environment using JPA data structures."
HolobiomicsLab 