paired-omics-data-structure-mapping
Summary
Validate paired omics project documents against a JSON schema to ensure structural compliance and data integrity before storage or submission. This skill enforces format requirements for linking MS/MS mass spectra with genome, biosynthetic gene cluster, and metadata annotations.
When to use
When you have a paired omics project document (JSON format) that combines MS/MS mass spectrometry data with genome identifiers, biosynthetic gene cluster information, sample preparation, extraction method, and instrumentation metadata, and you need to verify it conforms to the platform's structural and format requirements before uploading or storing it.
When NOT to use
- Document is already known to be valid and has passed validation in a prior workflow step.
- Data is in a format other than JSON (e.g., CSV, XML, or unstructured text) — requires format conversion first.
- Schema file is unavailable or corrupted — validation cannot proceed without the authoritative schema.
Inputs
- paired omics project JSON document
- JSON schema file (app/public/schema.json)
Outputs
- validation report with pass/fail status
- list of schema violations (if any)
- error messages detailing specific constraint violations
How to apply
Load the paired omics project JSON document and the JSON schema from app/public/schema.json. Apply JSON schema validation using npm test framework to check the document against all schema constraints. Capture validation results including pass/fail status, any schema violations, and error messages. Generate a structured validation report detailing compliance status and specific violations. The schema defines both structural requirements (e.g., required fields linking spectra to genome and gene cluster annotations) and format constraints (e.g., data types, identifier formats). Validation ensures data integrity before the web application stores the project as a file on disk or submits it to Zenodo.
Related tools
- npm (Test framework for running JSON schema validation checks against project documents)
- Github (Version control and collaboration platform for managing schema definitions and validation workflows) — https://github.com/iomega/paired-data-form
Examples
npm run test
Evaluation signals
- Validation report explicitly states 'pass' or 'fail' for the entire document against schema constraints.
- All mandatory schema fields (those linking MS/MS spectra, genome, and gene cluster data) are present and correctly formatted.
- Error messages for violations cite specific schema constraints (e.g., required field missing, incorrect data type, invalid identifier format).
- Documents passing validation can be successfully stored as project files on disk or submitted to the web application without structural errors.
- No schema violations are reported for documents that comply with the structural and format requirements defined in app/public/schema.json.
Limitations
- Validation checks only structural and format compliance; it does not verify semantic correctness (e.g., whether a genome identifier actually exists in GenBank or whether MS/MS spectra are scientifically meaningful).
- Schema version mismatches between the document and app/public/schema.json may cause false positives or false negatives if the schema has been updated without document migration.
- The npm test framework depends on npm dependencies being installed and up-to-date; missing or outdated dependencies may cause validation to fail or produce incomplete results.
Evidence
- [other] The JSON schema file located at app/public/schema.json that defines the structural and format requirements for paired omics data projects.: "The application uses a JSON schema file located at app/public/schema.json that defines the structural and format requirements for paired omics data projects."
- [other] The workflow for applying JSON schema validation using npm test framework to check documents against all schema constraints.: "Apply JSON schema validation using npm test framework to check the document against all schema constraints."
- [other] Capturing validation results including pass/fail status, schema violations, and error messages.: "Capture validation results including pass/fail status, any schema violations, and error messages."
- [readme] The schema describes the format of a paired omics project document.: "The JSON schema (app/public/schema.json) describes the format of an project."
- [readme] Links MS/MS mass spectra with genome, sample preparation, extraction method and instrumentation method.: "Links MS/MS mass spectra with genome, sample preparation, extraction method and instrumentation method"
1---2name: paired-omics-data-structure-mapping3description: Use when when you have a paired omics project document (JSON format) that combines MS/MS mass spectrometry data with genome identifiers, biosynthetic gene cluster information, sample preparation, extraction method, and instrumentation metadata, and you need to verify it conforms to the platform's.4license: CC-BY-4.05---67# paired-omics-data-structure-mapping89## Summary1011Validate paired omics project documents against a JSON schema to ensure structural compliance and data integrity before storage or submission. This skill enforces format requirements for linking MS/MS mass spectra with genome, biosynthetic gene cluster, and metadata annotations.1213## When to use1415When you have a paired omics project document (JSON format) that combines MS/MS mass spectrometry data with genome identifiers, biosynthetic gene cluster information, sample preparation, extraction method, and instrumentation metadata, and you need to verify it conforms to the platform's structural and format requirements before uploading or storing it.1617## When NOT to use1819- Document is already known to be valid and has passed validation in a prior workflow step.20- Data is in a format other than JSON (e.g., CSV, XML, or unstructured text) — requires format conversion first.21- Schema file is unavailable or corrupted — validation cannot proceed without the authoritative schema.2223## Inputs2425- paired omics project JSON document26- JSON schema file (app/public/schema.json)2728## Outputs2930- validation report with pass/fail status31- list of schema violations (if any)32- error messages detailing specific constraint violations3334## How to apply3536Load the paired omics project JSON document and the JSON schema from app/public/schema.json. Apply JSON schema validation using npm test framework to check the document against all schema constraints. Capture validation results including pass/fail status, any schema violations, and error messages. Generate a structured validation report detailing compliance status and specific violations. The schema defines both structural requirements (e.g., required fields linking spectra to genome and gene cluster annotations) and format constraints (e.g., data types, identifier formats). Validation ensures data integrity before the web application stores the project as a file on disk or submits it to Zenodo.3738## Related tools3940- **npm** (Test framework for running JSON schema validation checks against project documents)41- **Github** (Version control and collaboration platform for managing schema definitions and validation workflows) — https://github.com/iomega/paired-data-form4243## Examples4445```46npm run test47```4849## Evaluation signals5051- Validation report explicitly states 'pass' or 'fail' for the entire document against schema constraints.52- All mandatory schema fields (those linking MS/MS spectra, genome, and gene cluster data) are present and correctly formatted.53- Error messages for violations cite specific schema constraints (e.g., required field missing, incorrect data type, invalid identifier format).54- Documents passing validation can be successfully stored as project files on disk or submitted to the web application without structural errors.55- No schema violations are reported for documents that comply with the structural and format requirements defined in app/public/schema.json.5657## Limitations5859- Validation checks only structural and format compliance; it does not verify semantic correctness (e.g., whether a genome identifier actually exists in GenBank or whether MS/MS spectra are scientifically meaningful).60- Schema version mismatches between the document and app/public/schema.json may cause false positives or false negatives if the schema has been updated without document migration.61- The npm test framework depends on npm dependencies being installed and up-to-date; missing or outdated dependencies may cause validation to fail or produce incomplete results.6263## Evidence6465- [other] The JSON schema file located at app/public/schema.json that defines the structural and format requirements for paired omics data projects.: "The application uses a JSON schema file located at app/public/schema.json that defines the structural and format requirements for paired omics data projects."66- [other] The workflow for applying JSON schema validation using npm test framework to check documents against all schema constraints.: "Apply JSON schema validation using npm test framework to check the document against all schema constraints."67- [other] Capturing validation results including pass/fail status, schema violations, and error messages.: "Capture validation results including pass/fail status, any schema violations, and error messages."68- [readme] The schema describes the format of a paired omics project document.: "The [JSON schema (app/public/schema.json)](app/public/schema.json) describes the format of an project."69- [readme] Links MS/MS mass spectra with genome, sample preparation, extraction method and instrumentation method.: "Links MS/MS mass spectra with genome, sample preparation, extraction method and instrumentation method"
HolobiomicsLab