metabolomic-data-format-standardization
Summary
Convert raw metabolomic peak tables from instrument-specific formats into a standardized ExpressionSet object that downstream NOREVA assessment functions can consume. This skill enables unified preprocessing of multi-class and time-series metabolomic datasets regardless of their originating software tool.
When to use
You have raw peak table data from liquid chromatography–mass spectrometry (LC-MS) or related metabolomic instruments, generated by one of 12 supported software tools (or already in NOREVA's standardized format), and need to prepare it for preprocessing method evaluation or biomarker discovery workflows. The input peak table must include sample identifiers and feature intensity columns, and you have an accompanying label file defining sample classes or time-course points.
When NOT to use
- Peak table has already been converted to an ExpressionSet or equivalent annotated feature matrix object.
- Sample labels or class assignments are missing or cannot be matched to peak table columns by row count.
- Input peak table format is not one of the 12 supported software tools and does not conform to NOREVA's standardized schema (format code 1).
Inputs
- Peak table (CSV): feature rows × sample columns with intensity values
- Label file (CSV or table): sample identifiers with class or time-course annotations
- dataformat code: integer 1 (standardized) or 2 (software-generated)
Outputs
- ExpressionSet object: Biobase S4 class containing assayData (intensity matrix), phenoData (sample annotations), and featureData (feature metadata)
- Prepared input object for NOREVA preprocessing and assessment functions
How to apply
Call PrepareInputFiles() with three arguments: (1) dataformat code ('1' for standardized format, '2' for software-generated formats), (2) the filename of your raw peak table CSV, and (3) the filename of your label file specifying class/time assignments. The function loads both files using R base or readr functions, validates table structure by checking for required columns (sample identifiers, feature intensities) and verifying row count consistency between peak table and labels, then constructs a Biobase ExpressionSet object where intensities populate the expression matrix, sample metadata (class/time labels) populate phenoData, and feature metadata populate featureData. The returned ExpressionSet serves as the input object for all downstream NOREVA assessment functions (normulticlassqcall, nortimecourseqcall, etc.).
Related tools
- Biobase (Constructs and manages ExpressionSet objects containing expression matrices, sample phenotypes, and feature annotations) — https://bioconductor.org/packages/Biobase
- R (≥3.5) (Runtime environment for loading CSV files and executing PrepareInputFiles function) — https://www.r-project.org/
- readr (Efficient CSV loading and parsing of peak table and label files (alternative to R base functions))
- devtools (Installation of NOREVA package from GitHub repository) — https://github.com/idrblab/NOREVA
Examples
library(NOREVA); eset <- PrepareInuputFiles(dataformat=2, rawdata="peak_table.csv", label="sample_labels.csv")
Evaluation signals
- Returned object is a valid Biobase ExpressionSet with non-empty assayData, phenoData, and featureData slots.
- ExpressionSet row count (features) matches input peak table row count; column count (samples) matches both peak table and label file row counts.
- Sample phenotype labels in phenoData align 1:1 with ExpressionSet column identifiers (sample order preserved).
- No missing or mismatched values when sample identifiers from peak table are cross-referenced against label file.
- ExpressionSet is accepted without error as input to downstream NOREVA functions (normulticlassqcall, nortimecourseqcall, etc.).
Limitations
- PrepareInputFiles supports only 12 pre-defined instrument software formats (format code 2) plus NOREVA's standardized format (code 1); custom or unlisted formats require manual conversion to standardized format first.
- Label file must have exactly matching row count and aligned sample order with peak table; mismatches are caught only by row count validation, not by name matching.
- Peak table structure must include explicit sample identifier columns and intensity columns; ambiguous or unnamed columns may cause validation or assignment failures.
- No handling of missing intensity values, outliers, or quality control flags during standardization; such issues are addressed in downstream preprocessing functions.
Evidence
- [other] PrepareInputFiles accepts a peak table in either standardized format (format code 1) or in formats generated by 12 available software tools (format code 2), along with a label file for time-course/multi-class studies.: "PrepareInuputFiles accepts a peak table in either standardized format (format code 1) or in formats generated by 12 available software tools (format code 2), along with a label file for"
- [other] Construct an ExpressionSet object using Biobase, assigning intensity data to the expression matrix, sample metadata (including class/time-series labels) to phenoData, and feature metadata to featureData.: "Construct an ExpressionSet object using Biobase, assigning intensity data to the expression matrix, sample metadata (including class/time-series labels) to phenoData, and feature metadata to"
- [readme] This function enables the preparation and input of peak table which facilitate the subsequent application of other NOREVA functions.: "This function enables the preparation and input of peak table which facilitate the subsequent application of other NOREVA functions."
- [other] Validate table structure, checking for required columns (sample identifiers, feature intensities) and matching row counts between peak table and labels.: "Validate table structure, checking for required columns (sample identifiers, feature intensities) and matching row counts between peak table and labels"
- [intro] NOREVA package not only enables the pre-processing and assessment of multi-class/time-series metabolomic data: "NOREVA package not only enables the pre-processing and assessment of multi-class/time-series metabolomic data"
1---2name: metabolomic-data-format-standardization3description: Use when you have raw peak table data from liquid chromatography–mass spectrometry (LC-MS) or related metabolomic instruments, generated by one of 12 supported software tools (or already in NOREVA's standardized format), and need to prepare it for preprocessing method evaluation or biomarker.4license: CC-BY-4.05---67# metabolomic-data-format-standardization89## Summary1011Convert raw metabolomic peak tables from instrument-specific formats into a standardized ExpressionSet object that downstream NOREVA assessment functions can consume. This skill enables unified preprocessing of multi-class and time-series metabolomic datasets regardless of their originating software tool.1213## When to use1415You have raw peak table data from liquid chromatography–mass spectrometry (LC-MS) or related metabolomic instruments, generated by one of 12 supported software tools (or already in NOREVA's standardized format), and need to prepare it for preprocessing method evaluation or biomarker discovery workflows. The input peak table must include sample identifiers and feature intensity columns, and you have an accompanying label file defining sample classes or time-course points.1617## When NOT to use1819- Peak table has already been converted to an ExpressionSet or equivalent annotated feature matrix object.20- Sample labels or class assignments are missing or cannot be matched to peak table columns by row count.21- Input peak table format is not one of the 12 supported software tools and does not conform to NOREVA's standardized schema (format code 1).2223## Inputs2425- Peak table (CSV): feature rows × sample columns with intensity values26- Label file (CSV or table): sample identifiers with class or time-course annotations27- dataformat code: integer 1 (standardized) or 2 (software-generated)2829## Outputs3031- ExpressionSet object: Biobase S4 class containing assayData (intensity matrix), phenoData (sample annotations), and featureData (feature metadata)32- Prepared input object for NOREVA preprocessing and assessment functions3334## How to apply3536Call PrepareInputFiles() with three arguments: (1) dataformat code ('1' for standardized format, '2' for software-generated formats), (2) the filename of your raw peak table CSV, and (3) the filename of your label file specifying class/time assignments. The function loads both files using R base or readr functions, validates table structure by checking for required columns (sample identifiers, feature intensities) and verifying row count consistency between peak table and labels, then constructs a Biobase ExpressionSet object where intensities populate the expression matrix, sample metadata (class/time labels) populate phenoData, and feature metadata populate featureData. The returned ExpressionSet serves as the input object for all downstream NOREVA assessment functions (normulticlassqcall, nortimecourseqcall, etc.).3738## Related tools3940- **Biobase** (Constructs and manages ExpressionSet objects containing expression matrices, sample phenotypes, and feature annotations) — https://bioconductor.org/packages/Biobase41- **R (≥3.5)** (Runtime environment for loading CSV files and executing PrepareInputFiles function) — https://www.r-project.org/42- **readr** (Efficient CSV loading and parsing of peak table and label files (alternative to R base functions))43- **devtools** (Installation of NOREVA package from GitHub repository) — https://github.com/idrblab/NOREVA4445## Examples4647```48library(NOREVA); eset <- PrepareInuputFiles(dataformat=2, rawdata="peak_table.csv", label="sample_labels.csv")49```5051## Evaluation signals5253- Returned object is a valid Biobase ExpressionSet with non-empty assayData, phenoData, and featureData slots.54- ExpressionSet row count (features) matches input peak table row count; column count (samples) matches both peak table and label file row counts.55- Sample phenotype labels in phenoData align 1:1 with ExpressionSet column identifiers (sample order preserved).56- No missing or mismatched values when sample identifiers from peak table are cross-referenced against label file.57- ExpressionSet is accepted without error as input to downstream NOREVA functions (normulticlassqcall, nortimecourseqcall, etc.).5859## Limitations6061- PrepareInputFiles supports only 12 pre-defined instrument software formats (format code 2) plus NOREVA's standardized format (code 1); custom or unlisted formats require manual conversion to standardized format first.62- Label file must have exactly matching row count and aligned sample order with peak table; mismatches are caught only by row count validation, not by name matching.63- Peak table structure must include explicit sample identifier columns and intensity columns; ambiguous or unnamed columns may cause validation or assignment failures.64- No handling of missing intensity values, outliers, or quality control flags during standardization; such issues are addressed in downstream preprocessing functions.6566## Evidence6768- [other] PrepareInputFiles accepts a peak table in either standardized format (format code 1) or in formats generated by 12 available software tools (format code 2), along with a label file for time-course/multi-class studies.: "PrepareInuputFiles accepts a peak table in either standardized format (format code 1) or in formats generated by 12 available software tools (format code 2), along with a label file for"69- [other] Construct an ExpressionSet object using Biobase, assigning intensity data to the expression matrix, sample metadata (including class/time-series labels) to phenoData, and feature metadata to featureData.: "Construct an ExpressionSet object using Biobase, assigning intensity data to the expression matrix, sample metadata (including class/time-series labels) to phenoData, and feature metadata to"70- [readme] This function enables the preparation and input of peak table which facilitate the subsequent application of other NOREVA functions.: "This function enables the preparation and input of peak table which facilitate the subsequent application of other NOREVA functions."71- [other] Validate table structure, checking for required columns (sample identifiers, feature intensities) and matching row counts between peak table and labels.: "Validate table structure, checking for required columns (sample identifiers, feature intensities) and matching row counts between peak table and labels"72- [intro] NOREVA package not only enables the pre-processing and assessment of multi-class/time-series metabolomic data: "NOREVA package not only enables the pre-processing and assessment of multi-class/time-series metabolomic data"