Mercurial > repos > kkonganti > cfsan_centriflaken
annotate 0.4.2/modules/gen_samplesheet/README.md @ 105:52045ea4679d
"planemo upload"
| author | kkonganti |
|---|---|
| date | Thu, 27 Jun 2024 14:17:26 -0400 |
| parents | |
| children |
| rev | line source |
|---|---|
| kkonganti@105 | 1 # NextFlow DSL2 Module |
| kkonganti@105 | 2 |
| kkonganti@105 | 3 ```bash |
| kkonganti@105 | 4 GEN_SAMPLESHEET |
| kkonganti@105 | 5 ``` |
| kkonganti@105 | 6 |
| kkonganti@105 | 7 ## Description |
| kkonganti@105 | 8 |
| kkonganti@105 | 9 Generates a sample sheet in CSV format that contains required fields to be used to construct a Groovy Map of metadata. It requires as input, an absolute UNIX path to a folder containing only FASTQ files. This module requires the `fastq_dir_to_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: `val` |
| kkonganti@105 | 19 |
| kkonganti@105 | 20 Takes in the absolute UNIX path to a folder containing only FASTQ files (`inputdir`). |
| kkonganti@105 | 21 |
| kkonganti@105 | 22 Ex: |
| kkonganti@105 | 23 |
| kkonganti@105 | 24 ```groovy |
| kkonganti@105 | 25 '/hpc/scratch/test/reads' |
| 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 auto-generated 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. |