-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Victor Perez Meza
committed
Nov 7, 2024
1 parent
5ab2d30
commit a2c34f0
Showing
1 changed file
with
12 additions
and
4 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,18 @@ | ||
# Staging module for Miltenyi - MACSIMA to MCMICRO | ||
|
||
The macsima2mc.py script stages MACSima data sets for being registerd with ASHLAR in MCMICRO. | ||
|
||
## Docker implementation | ||
The script takes as main input the path to the cycle folder that cointains the raw tiles generated by the Miltenyi-MACSima platform. macsima2mc.py reads these tiles and distributes them into acquisition groups. i.e tiles with common rack, well, ROI and exposure levels will be written into an ome.tiff file with the necessary metadata for registration. To be more precise two such ome.tiff files will be generated per cycle, one corresponds to the background signal and the other to the markers signal. | ||
|
||
TODO: Add instructions on how to run the tool from Docker | ||
|
||
## CLI | ||
|
||
TODO: Add instructions on how to run the CLI | ||
| Argument| Type| Description | Default value | | ||
|----|----|----|---| | ||
|
||
- Required arguments: | ||
- -i [string/path]: absolute path to the the parent folder of the raw tiles, i.e. the cycle folder whose name follows the pattern X_Cycle_N, where N represents the cycle number. | ||
|
||
- -o [string/path]: absolute path to the | ||
|
||
- Optional arguments: | ||
- rm [string][default 'DAPI']: name of the reference marker for registration |