Skip to content

Commit bb73714

Browse files
CaroAMNmashehu
andauthored
Apply suggestions from code review
Co-authored-by: Matthias Hörtenhuber <mashehu@users.noreply.github.com>
1 parent 8ae1d64 commit bb73714

3 files changed

Lines changed: 14 additions & 11 deletions

File tree

.nf-core.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,7 @@ template:
99
name: lsmquant
1010
org: nf-core
1111
outdir: .
12+
skip_features:
13+
- fastqc
14+
- igenomes
1215
version: 1.0.0

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The pipeline consists of two major workflows `preprocessing` and the `full` work
5151

5252
### Preprocessing
5353

54-
Preprocessing is performed on raw 2D single-channel 16-bit `.tif` images produced by a light sheet microscope. Three individual steps are perfomed :
54+
Preprocessing is performed on raw 2D single-channel 16-bit `.tif` images produced by a light sheet microscope. Three individual steps are performed:
5555

5656
- **Intensity adjustments** to correct for the Gaussian shape of the lightsheet and intensity differences between adjacent tiles
5757
- **Image channel alignment** using a 2D rigid approach or a nonlinear 3D approach using Elastix.
@@ -63,7 +63,7 @@ Quantification of cell-nuclei is performed using a 3D-Unet. It is performed on t
6363

6464
### ARA Registration
6565

66-
Optionally registration to the Allen Refernce Atlas (ARA) for functional brain region annotation can be perfomed before segmentation.
66+
Optional registration to the Allen Reference Atlas (ARA) for functional brain region annotation can be perfomed before segmentation.
6767
This includes the following two steps:
6868

6969
- Downsampling of the high resolution stitched images
@@ -78,14 +78,14 @@ To run the pipeline you need to provide a samplesheet with your data in the foll
7878

7979
`samplesheet.csv`
8080

81-
```bash
81+
```csv
8282
sample_id,img_directory,parameter_file
8383
TEST1,path/to/image-files,path/to/parameter/file.csv
8484
```
8585

86-
The parameter csv file includes sample specific parameters that are used for processing the given data.It needs to follow a specific structure.
86+
The parameter csv file includes sample specific parameters that are used for processing the given data. It needs to follow a specific structure.
8787

88-
Please get the basic tempalte file here ( include maybe link to template csv which can be found in the repo ?)
88+
Please get the basic template file [here](../assets/params_template_lsmquant.csv).
8989
`parametersheet.csv`
9090

9191
Now, you can run the pipeline using:

docs/output.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ The directories listed below will be created in the results directory after the
1212

1313
The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes data using the following steps:
1414

15-
- [NumorphIntensity](#numorphintensity) - Mesures intensity parameters for illumination correction
15+
- [NumorphIntensity](#numorphintensity) - Measures intensity parameters for illumination correction
1616
- [NumorphAlign](#numorphalign) - Performs 2D rigid or 3D non-linear channel alignment
1717
- [NumorphStitch](#numoprhstitch) - Performs 2D iterative stitching of image tiles
1818
- [NumorphResample](#numorphresample) - Generate downsamppled images
19-
- [NumorphRegister](#numorphregister) - Performs registartion to the Allen Reference Atlas (ARA)
20-
- [Numorph3DUnet](#numorph3dunet) - Perfomrs cell-nuclei segmentation and quantification
21-
- [Mat2JSON] (#mat3json) - Converts `.mat`files to JSON
19+
- [NumorphRegister](#numorphregister) - Performs registration to the Allen Reference Atlas (ARA)
20+
- [Numorph3DUnet](#numorph3dunet) - Performs cell-nuclei segmentation and quantification
21+
- [Mat2JSON](#mat2json) - Converts `.mat`files to JSON
2222
- [MultiQC](#MultiQC) Aggregate report describing workflow run and tools used from the whole pipeline.
23-
- [Pipeline information](#pipeline-information) - Report metrics generated during the workflow execution
23+
- [Pipeline information](#pipeline-information) - Reports the metrics generated during the workflow execution
2424

2525
### NumorphIntensity
2626

@@ -30,7 +30,7 @@ The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes d
3030
- `Sample_id/intensity/results`
3131
- `NM_variables.mat`: Contains input and calculated parameters
3232
- `samples/`
33-
- `[channel]_x_y_z.tif`: Image comparing raw and adjusted image tiles for respective channel. Example for each tile of the middel z slice
33+
- `[channel]_x_y_z.tif`: Image comparing raw and adjusted image tiles for respective channel. Example for each tile of the middle z slice
3434
- `flatfield_*.png`: Flatfield correction heatmap for each channel
3535
- `tile_adj_*.png`: Heatmap of tile positions displaying illumination correction factor for each tile
3636
- `y_adj_*.png`: Intensity correction factors along the Y-axis(using intensity profiles specifically for the LaVision Ultramicroscope II)

0 commit comments

Comments
 (0)