Mercurial > repos > kkonganti > cfsan_centriflaken
annotate 0.3.0/modules/megahit/assemble/README.md @ 97:8d7f482c64de
"planemo upload"
| author | kkonganti |
|---|---|
| date | Fri, 29 Jul 2022 11:11:07 -0400 |
| parents | 295c2597a475 |
| children |
| rev | line source |
|---|---|
| kkonganti@92 | 1 # NextFlow DSL2 Module |
| kkonganti@92 | 2 |
| kkonganti@92 | 3 ```bash |
| kkonganti@92 | 4 MEGAHIT_ASSEMBLE |
| kkonganti@92 | 5 ``` |
| kkonganti@92 | 6 |
| kkonganti@92 | 7 ## Description |
| kkonganti@92 | 8 |
| kkonganti@92 | 9 Run `megahit` assembler tool on a list of read files in FASTQ format. |
| kkonganti@92 | 10 |
| kkonganti@92 | 11 \ |
| kkonganti@92 | 12 |
| kkonganti@92 | 13 |
| kkonganti@92 | 14 ### `input:` |
| kkonganti@92 | 15 |
| kkonganti@92 | 16 ___ |
| kkonganti@92 | 17 |
| kkonganti@92 | 18 Type: `tuple` |
| kkonganti@92 | 19 |
| kkonganti@92 | 20 Takes in the following tuple of metadata (`meta`) and a list of FASTQ files (short reads) of input type `path` (`reads`). |
| kkonganti@92 | 21 |
| kkonganti@92 | 22 Ex: |
| kkonganti@92 | 23 |
| kkonganti@92 | 24 ```groovy |
| kkonganti@92 | 25 [ [id: 'sample1', single_end: true], '/data/sample1/f_merged.fq.gz' ] |
| kkonganti@92 | 26 [ [id: 'sample1', single_end: false], ['/data/sample1/f1_merged.fq.gz', '/data/sample2/f2_merged.fq.gz'] ] |
| kkonganti@92 | 27 ``` |
| kkonganti@92 | 28 |
| kkonganti@92 | 29 \ |
| kkonganti@92 | 30 |
| kkonganti@92 | 31 |
| kkonganti@92 | 32 #### `meta` |
| kkonganti@92 | 33 |
| kkonganti@92 | 34 Type: Groovy Map |
| kkonganti@92 | 35 |
| kkonganti@92 | 36 A Groovy Map containing the metadata about the FASTQ file. |
| kkonganti@92 | 37 |
| kkonganti@92 | 38 Ex: |
| kkonganti@92 | 39 |
| kkonganti@92 | 40 ```groovy |
| kkonganti@92 | 41 [ id: 'KB01', strandedness: 'unstranded', single_end: true ] |
| kkonganti@92 | 42 ``` |
| kkonganti@92 | 43 |
| kkonganti@92 | 44 \ |
| kkonganti@92 | 45 |
| kkonganti@92 | 46 |
| kkonganti@92 | 47 #### `reads` |
| kkonganti@92 | 48 |
| kkonganti@92 | 49 Type: `path` |
| kkonganti@92 | 50 |
| kkonganti@92 | 51 NextFlow input type of `path` pointing to short read files in FASTQ format that need to be *de novo* assembled. |
| kkonganti@92 | 52 |
| kkonganti@92 | 53 \ |
| kkonganti@92 | 54 |
| kkonganti@92 | 55 |
| kkonganti@92 | 56 #### `args` |
| kkonganti@92 | 57 |
| kkonganti@92 | 58 Type: Groovy String |
| kkonganti@92 | 59 |
| kkonganti@92 | 60 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@92 | 61 |
| kkonganti@92 | 62 Ex: |
| kkonganti@92 | 63 |
| kkonganti@92 | 64 ```groovy |
| kkonganti@92 | 65 withName: 'MEGAHIT_ASSEMBLE' { |
| kkonganti@92 | 66 ext.args = '--keep-tmp-files' |
| kkonganti@92 | 67 } |
| kkonganti@92 | 68 ``` |
| kkonganti@92 | 69 |
| kkonganti@92 | 70 \ |
| kkonganti@92 | 71 |
| kkonganti@92 | 72 |
| kkonganti@92 | 73 ### `output:` |
| kkonganti@92 | 74 |
| kkonganti@92 | 75 ___ |
| kkonganti@92 | 76 |
| kkonganti@92 | 77 Type: `tuple` |
| kkonganti@92 | 78 |
| kkonganti@92 | 79 Outputs a tuple of metadata (`meta` from `input:`) and `megahit` assembled contigs file in FASTA format. |
| kkonganti@92 | 80 |
| kkonganti@92 | 81 \ |
| kkonganti@92 | 82 |
| kkonganti@92 | 83 |
| kkonganti@92 | 84 #### `assembly` |
| kkonganti@92 | 85 |
| kkonganti@92 | 86 Type: `path` |
| kkonganti@92 | 87 |
| kkonganti@92 | 88 NextFlow output type of `path` pointing to the `megahit` assembler results file (`final.contigs.fa`) per sample (`id:`) i.e., the final assembled contigs file in FASTA format. |
| kkonganti@92 | 89 |
| kkonganti@92 | 90 \ |
| kkonganti@92 | 91 |
| kkonganti@92 | 92 |
| kkonganti@92 | 93 #### `versions` |
| kkonganti@92 | 94 |
| kkonganti@92 | 95 Type: `path` |
| kkonganti@92 | 96 |
| kkonganti@92 | 97 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process. |