Mercurial > repos > kkonganti > cfsan_bettercallsal
annotate 0.5.0/modules/seqkit/seq/README.md @ 1:365849f031fd
"planemo upload"
| author | kkonganti |
|---|---|
| date | Mon, 05 Jun 2023 18:48:51 -0400 |
| parents | |
| children |
| rev | line source |
|---|---|
| kkonganti@1 | 1 # NextFlow DSL2 Module |
| kkonganti@1 | 2 |
| kkonganti@1 | 3 ```bash |
| kkonganti@1 | 4 SEQKIT_SEQ |
| kkonganti@1 | 5 ``` |
| kkonganti@1 | 6 |
| kkonganti@1 | 7 ## Description |
| kkonganti@1 | 8 |
| kkonganti@1 | 9 Run `seqkit seq` command on reads in FASTQ format. Produces a filtered FASTQ file as per the filter strategy mentioned using the `ext.args` within the process scope. |
| kkonganti@1 | 10 |
| kkonganti@1 | 11 \ |
| kkonganti@1 | 12 |
| kkonganti@1 | 13 |
| kkonganti@1 | 14 ### `input:` |
| kkonganti@1 | 15 |
| kkonganti@1 | 16 ___ |
| kkonganti@1 | 17 |
| kkonganti@1 | 18 Type: `tuple` |
| kkonganti@1 | 19 |
| kkonganti@1 | 20 Takes in the following tuple of metadata (`meta`) and a list of reads of type `path` (`reads`) per sample (`id:`). |
| kkonganti@1 | 21 |
| kkonganti@1 | 22 Ex: |
| kkonganti@1 | 23 |
| kkonganti@1 | 24 ```groovy |
| kkonganti@1 | 25 [ |
| kkonganti@1 | 26 [ id: 'FAL00870', |
| kkonganti@1 | 27 strandedness: 'unstranded', |
| kkonganti@1 | 28 single_end: true, |
| kkonganti@1 | 29 centrifuge_x: '/hpc/db/centrifuge/2022-04-12/ab' |
| kkonganti@1 | 30 ], |
| kkonganti@1 | 31 '/hpc/scratch/test/FAL000870/f1.merged.fq.gz' |
| kkonganti@1 | 32 ] |
| kkonganti@1 | 33 ``` |
| kkonganti@1 | 34 |
| kkonganti@1 | 35 \ |
| kkonganti@1 | 36 |
| kkonganti@1 | 37 |
| kkonganti@1 | 38 #### `meta` |
| kkonganti@1 | 39 |
| kkonganti@1 | 40 Type: Groovy Map |
| kkonganti@1 | 41 |
| kkonganti@1 | 42 A Groovy Map containing the metadata about the FASTQ file. |
| kkonganti@1 | 43 |
| kkonganti@1 | 44 Ex: |
| kkonganti@1 | 45 |
| kkonganti@1 | 46 ```groovy |
| kkonganti@1 | 47 [ |
| kkonganti@1 | 48 id: 'FAL00870', |
| kkonganti@1 | 49 strandedness: 'unstranded', |
| kkonganti@1 | 50 single_end: true |
| kkonganti@1 | 51 ] |
| kkonganti@1 | 52 ``` |
| kkonganti@1 | 53 |
| kkonganti@1 | 54 \ |
| kkonganti@1 | 55 |
| kkonganti@1 | 56 |
| kkonganti@1 | 57 #### `reads` |
| kkonganti@1 | 58 |
| kkonganti@1 | 59 Type: `path` |
| kkonganti@1 | 60 |
| kkonganti@1 | 61 NextFlow input type of `path` pointing to FASTQ files on which `seqkit seq` should be run. |
| kkonganti@1 | 62 |
| kkonganti@1 | 63 \ |
| kkonganti@1 | 64 |
| kkonganti@1 | 65 |
| kkonganti@1 | 66 #### `args` |
| kkonganti@1 | 67 |
| kkonganti@1 | 68 Type: Groovy String |
| kkonganti@1 | 69 |
| kkonganti@1 | 70 String of optional command-line arguments to be passed to the tool. This can be mentioned in `process` scope within `withName:process_name` block using `ext.args` option within your `nextflow.config` file. |
| kkonganti@1 | 71 |
| kkonganti@1 | 72 Ex: |
| kkonganti@1 | 73 |
| kkonganti@1 | 74 ```groovy |
| kkonganti@1 | 75 withName: 'SEQKIT_SEQ' { |
| kkonganti@1 | 76 ext.args = '--max-len 4000' |
| kkonganti@1 | 77 } |
| kkonganti@1 | 78 ``` |
| kkonganti@1 | 79 |
| kkonganti@1 | 80 ### `output:` |
| kkonganti@1 | 81 |
| kkonganti@1 | 82 ___ |
| kkonganti@1 | 83 |
| kkonganti@1 | 84 Type: `tuple` |
| kkonganti@1 | 85 |
| kkonganti@1 | 86 Outputs a tuple of metadata (`meta` from `input:`) and filtered gzipped FASTQ file. |
| kkonganti@1 | 87 |
| kkonganti@1 | 88 \ |
| kkonganti@1 | 89 |
| kkonganti@1 | 90 |
| kkonganti@1 | 91 #### `fastx` |
| kkonganti@1 | 92 |
| kkonganti@1 | 93 Type: `path` |
| kkonganti@1 | 94 |
| kkonganti@1 | 95 NextFlow output type of `path` pointing to the FASTQ format filtered gzipped file per sample (`id:`). |
| kkonganti@1 | 96 |
| kkonganti@1 | 97 \ |
| kkonganti@1 | 98 |
| kkonganti@1 | 99 |
| kkonganti@1 | 100 #### `versions` |
| kkonganti@1 | 101 |
| kkonganti@1 | 102 Type: `path` |
| kkonganti@1 | 103 |
| kkonganti@1 | 104 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process. |