-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Juranic/merfish dirschema fixes (#1362)
* Create merfish-v2.3.yaml Fixes previous version errors - *.dax extension changed to lowercase and pattern: raw/data/*.inf added. * Update CHANGELOG.md * Documentation: Update merfish --------- Co-authored-by: Juan Puerto <=> Co-authored-by: jpuerto-psc <[email protected]>
- Loading branch information
1 parent
0b76e77
commit 7950f59
Showing
3 changed files
with
123 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,7 +28,34 @@ Related files: | |
| <br> | ||
|
|
||
| ## Directory schemas | ||
| <summary><b>Version 2.2 (use this one)</b></summary> | ||
| <summary><b>Version 2.3 (use this one)</b></summary> | ||
|
|
||
| | pattern | required? | description | | ||
| | --- | --- | --- | | ||
| | <code>extras\/.*</code> | ✓ | Folder for general lab-specific files related to the dataset. | | ||
| | <code>extras\/microscope_hardware\.json</code> | ✓ | **[QA/QC]** A file generated by the micro-meta app that contains a description of the hardware components of the microscope. Email HuBMAP Consortium Help Desk <[email protected]> if help is required in generating this document. | | ||
| | <code>extras\/microscope_settings\.json</code> | | **[QA/QC]** A file generated by the micro-meta app that contains a description of the settings that were used to acquire the image data. Email HuBMAP Consortium Help Desk <[email protected]> if help is required in generating this document. | | ||
| | <code>raw\/.*</code> | ✓ | All raw data files for the experiment. | | ||
| | <code>raw\/additional_panels_used\.csv</code> | | If multiple commercial probe panels were used, then the primary probe panel should be selected in the "oligo_probe_panel" metadata field. The additional panels must be included in this file. Each panel record should include:manufacturer, model/name, product code. | | ||
| | <code>raw\/gene_panel\.csv</code> | ✓ | The list of target genes. The expected format is gene_id (ensembl ID), gene_name. | | ||
| | <code>raw\/custom_probe_set\.csv</code> | | This file should contain any custom probes used and must be included if the metadata field "is_custom_probes_used" is "Yes". The file should minimally include:target gene id, probe seq, probe id. The contents of this file are modeled after the 10x Genomics probe set file (see <https://support.10xgenomics.com/spatial-gene-expression-ffpe/probe-sets/probe-set-file-descriptions/probe-set-file-descriptions#probe_set_csv_file>). | | ||
| | <code>raw\/micron_to_mosaic_pixel_transform\.csv</code> | | Matrix used to transform from pixels to physical distance. | | ||
| | <code>raw\/manifest\.json</code> | ✓ | This file contains stain by channel details and pixel details. | | ||
| | <code>raw\/codebook\.csv</code> | ✓ | CSV containing codebook information for the experiment. Rows are barcodes and columns are imaging rounds. The first column is the barcode target, and the following column IDs are expected to be sequential, and round identifiers are expected to be integers (not roman numerals). | | ||
| | <code>raw\/positions\.csv</code> | ✓ | File that includes the top left coordinate of each tiled image. This is required to stitch the images. | | ||
| | <code>raw\/dataorganization\.csv</code> | ✓ | Necessary image definitions | | ||
| | <code>raw\/data\/.*</code> | ✓ | All raw stack data files for the MERFISH experiment. | | ||
| | <code>raw\/data\/[^\/]+\.dax</code> | ✓ | The raw image stack. | | ||
| | <code>raw\/data\/[^\/]+\.inf</code> | ✓ | Information file with dax image format specifications. Variable expected for downstream processing with PIPEFISH are frame dimensions, number of frames, little/big endian, stage X and Y locations, lock target, scalemin, and scalemax. | | ||
| | <code>raw\/images\/.*</code> | ✓ | Directory containing raw image files. This directory should include at least one raw file. | | ||
| | <code>raw\/images\/[^\/]+\.tif</code> | ✓ | Raw microscope file for the experiment. | | ||
| | <code>lab_processed\/.*</code> | ✓ | Experiment files that were processed by the lab generating the data. | | ||
| | <code>lab_processed\/detected_transcripts\.csv</code> | ✓ | A file containing the locations of each RNA target. | | ||
| | <code>lab_processed\/images\/.*</code> | ✓ | Processed image files | | ||
| | <code>lab_processed\/images\/[^\/]+\.ome\.tiff</code> (example: <code>lab_processed/images/HBM892.MDXS.293.ome.tiff</code>) | ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. For Visium this stitched file should only include the single capture area relevant to the current dataset. For GeoMx there will be one OME TIFF file per slide, with each slide including multiple AOIs. See the following link for the set of fields that are required in the OME TIFF file XML header. <https://docs.google.com/spreadsheets/d/1YnmdTAA0Z9MKN3OjR3Sca8pz-LNQll91wdQoRPSP6Q4/edit#gid=0> | | ||
| | <code>lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv</code> | ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed <https://docs.google.com/spreadsheets/d/1xEJSb0xn5C5fB3k62pj1CyHNybpt4-YtvUs5SUMS44o/edit#gid=0> | | ||
|
|
||
| <summary><b>Version 2.2</b></summary> | ||
|
|
||
| | pattern | required? | description | | ||
| | --- | --- | --- | | ||
|
|
||
94 changes: 94 additions & 0 deletions
94
src/ingest_validation_tools/directory-schemas/merfish-v2.3.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| files: | ||
| - | ||
| pattern: extras\/.* | ||
| required: True | ||
| description: Folder for general lab-specific files related to the dataset. | ||
| - | ||
| pattern: extras\/microscope_hardware\.json | ||
| required: True | ||
| description: A file generated by the micro-meta app that contains a description of the hardware components of the microscope. Email HuBMAP Consortium Help Desk <[email protected]> if help is required in generating this document. | ||
| is_qa_qc: True | ||
| - | ||
| pattern: extras\/microscope_settings\.json | ||
| required: False | ||
| description: A file generated by the micro-meta app that contains a description of the settings that were used to acquire the image data. Email HuBMAP Consortium Help Desk <[email protected]> if help is required in generating this document. | ||
| is_qa_qc: True | ||
| - | ||
| pattern: raw\/.* | ||
| required: True | ||
| description: All raw data files for the experiment. | ||
| - | ||
| pattern: raw\/additional_panels_used\.csv | ||
| required: False | ||
| description: If multiple commercial probe panels were used, then the primary probe panel should be selected in the "oligo_probe_panel" metadata field. The additional panels must be included in this file. Each panel record should include:manufacturer, model/name, product code. | ||
| - | ||
| pattern: raw\/gene_panel\.csv | ||
| required: True | ||
| description: The list of target genes. The expected format is gene_id (ensembl ID), gene_name. | ||
| - | ||
| pattern: raw\/custom_probe_set\.csv | ||
| required: False | ||
| description: This file should contain any custom probes used and must be included if the metadata field "is_custom_probes_used" is "Yes". The file should minimally include:target gene id, probe seq, probe id. The contents of this file are modeled after the 10x Genomics probe set file (see <https://support.10xgenomics.com/spatial-gene-expression-ffpe/probe-sets/probe-set-file-descriptions/probe-set-file-descriptions#probe_set_csv_file>). | ||
| - | ||
| pattern: raw\/micron_to_mosaic_pixel_transform\.csv | ||
| required: False | ||
| description: Matrix used to transform from pixels to physical distance. | ||
| - | ||
| pattern: raw\/manifest\.json | ||
| required: True | ||
| description: This file contains stain by channel details and pixel details. | ||
| - | ||
| pattern: raw\/codebook\.csv | ||
| required: True | ||
| description: CSV containing codebook information for the experiment. Rows are barcodes and columns are imaging rounds. The first column is the barcode target, and the following column IDs are expected to be sequential, and round identifiers are expected to be integers (not roman numerals). | ||
| - | ||
| pattern: raw\/positions\.csv | ||
| required: True | ||
| description: File that includes the top left coordinate of each tiled image. This is required to stitch the images. | ||
| - | ||
| pattern: raw\/dataorganization\.csv | ||
| required: True | ||
| description: Necessary image definitions | ||
| - | ||
| pattern: raw\/data\/.* | ||
| required: True | ||
| description: All raw stack data files for the MERFISH experiment. | ||
| - | ||
| pattern: raw\/data\/[^\/]+\.dax | ||
| required: True | ||
| description: The raw image stack. | ||
| - | ||
| pattern: raw\/data\/[^\/]+\.inf | ||
| required: True | ||
| description: Information file with dax image format specifications. Variable expected for downstream processing with PIPEFISH are frame dimensions, number of frames, little/big endian, stage X and Y locations, lock target, scalemin, and scalemax. | ||
| - | ||
| pattern: raw\/images\/.* | ||
| required: True | ||
| description: Directory containing raw image files. This directory should include at least one raw file. | ||
| - | ||
| pattern: raw\/images\/[^\/]+\.tif | ||
| required: True | ||
| description: Raw microscope file for the experiment. | ||
| - | ||
| pattern: lab_processed\/.* | ||
| required: True | ||
| description: Experiment files that were processed by the lab generating the data. | ||
| - | ||
| pattern: lab_processed\/detected_transcripts\.csv | ||
| required: True | ||
| description: A file containing the locations of each RNA target. | ||
| - | ||
| pattern: lab_processed\/images\/.* | ||
| required: True | ||
| description: Processed image files | ||
| - | ||
| pattern: lab_processed\/images\/[^\/]+\.ome\.tiff | ||
| required: True | ||
| description: OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. For Visium this stitched file should only include the single capture area relevant to the current dataset. For GeoMx there will be one OME TIFF file per slide, with each slide including multiple AOIs. See the following link for the set of fields that are required in the OME TIFF file XML header. <https://docs.google.com/spreadsheets/d/1YnmdTAA0Z9MKN3OjR3Sca8pz-LNQll91wdQoRPSP6Q4/edit#gid=0> | ||
| is_qa_qc: False | ||
| example: lab_processed/images/HBM892.MDXS.293.ome.tiff | ||
| - | ||
| pattern: lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv | ||
| required: True | ||
| description: This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed <https://docs.google.com/spreadsheets/d/1xEJSb0xn5C5fB3k62pj1CyHNybpt4-YtvUs5SUMS44o/edit#gid=0> | ||
| is_qa_qc: False |