Mercurial > repos > kkonganti > cfsan_centriflaken
annotate 0.2.1/modules/spades/assemble/README.md @ 34:4f9f145d1946
"planemo upload"
| author | kkonganti |
|---|---|
| date | Wed, 29 Jun 2022 15:27:50 -0400 |
| parents | 77494b0fa3c7 |
| children |
| rev | line source |
|---|---|
| kkonganti@0 | 1 # NextFlow DSL2 Module |
| kkonganti@0 | 2 |
| kkonganti@0 | 3 ```bash |
| kkonganti@0 | 4 SPADES_ASSEMBLE |
| kkonganti@0 | 5 ``` |
| kkonganti@0 | 6 |
| kkonganti@0 | 7 ## Description |
| kkonganti@0 | 8 |
| kkonganti@0 | 9 Run `spades` assembler tool on a list of read files in FASTQ format. |
| kkonganti@0 | 10 |
| kkonganti@0 | 11 \ |
| kkonganti@0 | 12 |
| kkonganti@0 | 13 |
| kkonganti@0 | 14 ### `input:` |
| kkonganti@0 | 15 |
| kkonganti@0 | 16 ___ |
| kkonganti@0 | 17 |
| kkonganti@0 | 18 Type: `tuple` |
| kkonganti@0 | 19 |
| kkonganti@0 | 20 Takes in the following tuple of metadata (`meta`) and a list of FASTQ files from various platforms of input type `path` (`illumina`, `pacbio`, `nanopore`). |
| kkonganti@0 | 21 |
| kkonganti@0 | 22 Ex: |
| kkonganti@0 | 23 |
| kkonganti@0 | 24 ```groovy |
| kkonganti@0 | 25 [ [id: 'sample1', single_end: true], '/data/sample1/f_merged.fq.gz' ] |
| kkonganti@0 | 26 [ [id: 'sample1', single_end: false], ['/data/sample1/f1_merged.fq.gz', '/data/sample2/f2_merged.fq.gz'], ['/data/sample1/nanopore.fastq'], ['/data/sample1/pacbio.fastq'] ] |
| kkonganti@0 | 27 ``` |
| kkonganti@0 | 28 |
| kkonganti@0 | 29 \ |
| kkonganti@0 | 30 |
| kkonganti@0 | 31 |
| kkonganti@0 | 32 #### `meta` |
| kkonganti@0 | 33 |
| kkonganti@0 | 34 Type: Groovy Map |
| kkonganti@0 | 35 |
| kkonganti@0 | 36 A Groovy Map containing the metadata about the FASTQ file. |
| kkonganti@0 | 37 |
| kkonganti@0 | 38 Ex: |
| kkonganti@0 | 39 |
| kkonganti@0 | 40 ```groovy |
| kkonganti@0 | 41 [ id: 'FAL00870', strandedness: 'unstranded', single_end: true ] |
| kkonganti@0 | 42 ``` |
| kkonganti@0 | 43 |
| kkonganti@0 | 44 \ |
| kkonganti@0 | 45 |
| kkonganti@0 | 46 |
| kkonganti@0 | 47 #### `illumina` |
| kkonganti@0 | 48 |
| kkonganti@0 | 49 Type: `path` |
| kkonganti@0 | 50 |
| kkonganti@0 | 51 NextFlow input type of `path` pointing to Illumina read files in FASTQ format that need to be *de novo* assembled along with reads from any other sequencing platforms, if any. |
| kkonganti@0 | 52 |
| kkonganti@0 | 53 \ |
| kkonganti@0 | 54 |
| kkonganti@0 | 55 |
| kkonganti@0 | 56 #### `nanopore` |
| kkonganti@0 | 57 |
| kkonganti@0 | 58 Type: `path` |
| kkonganti@0 | 59 |
| kkonganti@0 | 60 NextFlow input type of `path` pointing to Oxford Nanopore read files in FASTQ format that need to be *de novo* assembled along with reads from any other sequencing platforms, if any. |
| kkonganti@0 | 61 |
| kkonganti@0 | 62 \ |
| kkonganti@0 | 63 |
| kkonganti@0 | 64 |
| kkonganti@0 | 65 #### `pacbio` |
| kkonganti@0 | 66 |
| kkonganti@0 | 67 Type: `path` |
| kkonganti@0 | 68 |
| kkonganti@0 | 69 NextFlow input type of `path` pointing to PacBio read files in FASTQ format that need to be *de novo* assembled along with reads from any other sequencing platforms, if any. |
| kkonganti@0 | 70 |
| kkonganti@0 | 71 \ |
| kkonganti@0 | 72 |
| kkonganti@0 | 73 |
| kkonganti@0 | 74 #### `args` |
| kkonganti@0 | 75 |
| kkonganti@0 | 76 Type: Groovy String |
| kkonganti@0 | 77 |
| kkonganti@0 | 78 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@0 | 79 |
| kkonganti@0 | 80 Ex: |
| kkonganti@0 | 81 |
| kkonganti@0 | 82 ```groovy |
| kkonganti@0 | 83 withName: 'SPADES_ASSEMBLE' { |
| kkonganti@0 | 84 ext.args = '--rna' |
| kkonganti@0 | 85 } |
| kkonganti@0 | 86 ``` |
| kkonganti@0 | 87 |
| kkonganti@0 | 88 \ |
| kkonganti@0 | 89 |
| kkonganti@0 | 90 |
| kkonganti@0 | 91 ### `output:` |
| kkonganti@0 | 92 |
| kkonganti@0 | 93 ___ |
| kkonganti@0 | 94 |
| kkonganti@0 | 95 Type: `tuple` |
| kkonganti@0 | 96 |
| kkonganti@0 | 97 Outputs a tuple of metadata (`meta` from `input:`) and `spades` assembled scaffolds file in FASTA format. |
| kkonganti@0 | 98 |
| kkonganti@0 | 99 \ |
| kkonganti@0 | 100 |
| kkonganti@0 | 101 |
| kkonganti@0 | 102 #### `assembly` |
| kkonganti@0 | 103 |
| kkonganti@0 | 104 Type: `path` |
| kkonganti@0 | 105 |
| kkonganti@0 | 106 NextFlow output type of `path` pointing to the `spades` assembler results file (`scaffolds.fasta`) per sample (`id:`) i.e., the final assembled scaffolds file in FASTA format. |
| kkonganti@0 | 107 |
| kkonganti@0 | 108 \ |
| kkonganti@0 | 109 |
| kkonganti@0 | 110 |
| kkonganti@0 | 111 #### `versions` |
| kkonganti@0 | 112 |
| kkonganti@0 | 113 Type: `path` |
| kkonganti@0 | 114 |
| kkonganti@0 | 115 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process. |