Mercurial > repos > kkonganti > cfsan_centriflaken
annotate 0.4.2/modules/samplesheet_check/README.md @ 130:04f6ac8ca13c
planemo upload
| author | kkonganti |
|---|---|
| date | Wed, 03 Jul 2024 15:16:39 -0400 |
| parents | 52045ea4679d |
| children |
| rev | line source |
|---|---|
| kkonganti@105 | 1 # NextFlow DSL2 Module |
| kkonganti@105 | 2 |
| kkonganti@105 | 3 ```bash |
| kkonganti@105 | 4 SAMPLESHEET_CHECK |
| kkonganti@105 | 5 ``` |
| kkonganti@105 | 6 |
| kkonganti@105 | 7 ## Description |
| kkonganti@105 | 8 |
| kkonganti@105 | 9 Checks the validity of the sample sheet in CSV format to make sure there are required mandatory fields. This module generally succeeds `GEN_SAMPLESHEET` module as part of the `cpipes` pipelines to make sure that all fields of the columns are properly formatted to be used as Groovy Map for `meta` which is of input type `val`. This module requires the `check_samplesheet.py` script to be present in the `bin` folder from where the NextFlow script including this module will be executed |
| kkonganti@105 | 10 |
| kkonganti@105 | 11 \ |
| kkonganti@105 | 12 |
| kkonganti@105 | 13 |
| kkonganti@105 | 14 ### `input:` |
| kkonganti@105 | 15 |
| kkonganti@105 | 16 ___ |
| kkonganti@105 | 17 |
| kkonganti@105 | 18 Type: `path` |
| kkonganti@105 | 19 |
| kkonganti@105 | 20 Takes in the absolute UNIX path to the sample sheet in CSV format (`samplesheet`). |
| kkonganti@105 | 21 |
| kkonganti@105 | 22 Ex: |
| kkonganti@105 | 23 |
| kkonganti@105 | 24 ```groovy |
| kkonganti@105 | 25 '/hpc/scratch/test/reads/output/gen_samplesheet/autogen_samplesheet.csv' |
| kkonganti@105 | 26 ``` |
| kkonganti@105 | 27 |
| kkonganti@105 | 28 \ |
| kkonganti@105 | 29 |
| kkonganti@105 | 30 |
| kkonganti@105 | 31 ### `output:` |
| kkonganti@105 | 32 |
| kkonganti@105 | 33 ___ |
| kkonganti@105 | 34 |
| kkonganti@105 | 35 Type: `path` |
| kkonganti@105 | 36 |
| kkonganti@105 | 37 NextFlow output of type `path` pointing to properly formatted CSV sample sheet (`csv`). |
| kkonganti@105 | 38 |
| kkonganti@105 | 39 \ |
| kkonganti@105 | 40 |
| kkonganti@105 | 41 |
| kkonganti@105 | 42 #### `csv` |
| kkonganti@105 | 43 |
| kkonganti@105 | 44 Type: `path` |
| kkonganti@105 | 45 |
| kkonganti@105 | 46 NextFlow output type of `path` pointing to auto-generated CSV sample sheet for all FASTQ files present in the folder given by NextFlow input type of `val` (`inputdir`). |
| kkonganti@105 | 47 |
| kkonganti@105 | 48 \ |
| kkonganti@105 | 49 |
| kkonganti@105 | 50 |
| kkonganti@105 | 51 #### `versions` |
| kkonganti@105 | 52 |
| kkonganti@105 | 53 Type: `path` |
| kkonganti@105 | 54 |
| kkonganti@105 | 55 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process. |