Mercurial > repos > kkonganti > cfsan_centriflaken
annotate 0.3.0/modules/abricate/run/README.md @ 92:295c2597a475
"planemo upload"
| author | kkonganti |
|---|---|
| date | Tue, 19 Jul 2022 10:07:24 -0400 |
| parents | |
| children |
| rev | line source |
|---|---|
| kkonganti@92 | 1 # NextFlow DSL2 Module |
| kkonganti@92 | 2 |
| kkonganti@92 | 3 ```bash |
| kkonganti@92 | 4 ABRICATE_RUN |
| kkonganti@92 | 5 ``` |
| kkonganti@92 | 6 |
| kkonganti@92 | 7 ## Description |
| kkonganti@92 | 8 |
| kkonganti@92 | 9 Run `abricate` tool on a list of assembled contigs in FASTA format given a list of database names. Produces a single output table in ASCII text format per database. |
| 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 assemled contig FASTA files of input type `path` (`assembly`). |
| 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_assembly.fa' ] |
| kkonganti@92 | 26 ``` |
| kkonganti@92 | 27 |
| kkonganti@92 | 28 \ |
| kkonganti@92 | 29 |
| kkonganti@92 | 30 |
| kkonganti@92 | 31 #### `meta` |
| kkonganti@92 | 32 |
| kkonganti@92 | 33 Type: Groovy Map |
| kkonganti@92 | 34 |
| kkonganti@92 | 35 A Groovy Map containing the metadata about the FASTQ file. |
| kkonganti@92 | 36 |
| kkonganti@92 | 37 Ex: |
| kkonganti@92 | 38 |
| kkonganti@92 | 39 ```groovy |
| kkonganti@92 | 40 [ id: 'FAL00870', strandedness: 'unstranded', single_end: true ] |
| kkonganti@92 | 41 ``` |
| kkonganti@92 | 42 |
| kkonganti@92 | 43 \ |
| kkonganti@92 | 44 |
| kkonganti@92 | 45 |
| kkonganti@92 | 46 #### `assembly` |
| kkonganti@92 | 47 |
| kkonganti@92 | 48 Type: `path` |
| kkonganti@92 | 49 |
| kkonganti@92 | 50 NextFlow input type of `path` pointing to assembled contig file in FASTA format. |
| kkonganti@92 | 51 |
| kkonganti@92 | 52 \ |
| kkonganti@92 | 53 |
| kkonganti@92 | 54 |
| kkonganti@92 | 55 #### `abdbs` |
| kkonganti@92 | 56 |
| kkonganti@92 | 57 Type: `val` |
| kkonganti@92 | 58 |
| kkonganti@92 | 59 Nextflow input type of `val` containing a list of at least one of the following database names on which `abricate` should be run. |
| kkonganti@92 | 60 |
| kkonganti@92 | 61 Ex: |
| kkonganti@92 | 62 |
| kkonganti@92 | 63 ```groovy |
| kkonganti@92 | 64 [ 'resfinder', 'megares', 'ncbi', 'ncbiamrplus', 'argannot' , 'ecoli_vf' ] |
| kkonganti@92 | 65 ``` |
| kkonganti@92 | 66 |
| kkonganti@92 | 67 \ |
| kkonganti@92 | 68 |
| kkonganti@92 | 69 |
| kkonganti@92 | 70 ### `output:` |
| kkonganti@92 | 71 |
| kkonganti@92 | 72 ___ |
| kkonganti@92 | 73 |
| kkonganti@92 | 74 Type: `tuple` |
| kkonganti@92 | 75 |
| kkonganti@92 | 76 Outputs a tuple of metadata (`meta` from `input:`) and list of `abricate` result files (`abricated`). |
| kkonganti@92 | 77 |
| kkonganti@92 | 78 \ |
| kkonganti@92 | 79 |
| kkonganti@92 | 80 |
| kkonganti@92 | 81 #### `abricated` |
| kkonganti@92 | 82 |
| kkonganti@92 | 83 Type: `path` |
| kkonganti@92 | 84 |
| kkonganti@92 | 85 NextFlow output type of `path` pointing to the `abricate` results table file per sample (`id:`). |
| kkonganti@92 | 86 |
| kkonganti@92 | 87 \ |
| kkonganti@92 | 88 |
| kkonganti@92 | 89 |
| kkonganti@92 | 90 #### `versions` |
| kkonganti@92 | 91 |
| kkonganti@92 | 92 Type: `path` |
| kkonganti@92 | 93 |
| kkonganti@92 | 94 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process. |