annotate 1.0.0/modules/abricate/run/README.md @ 0:0a8dda29956e draft default tip

planemo upload
author galaxytrakr
date Thu, 28 May 2026 20:41:10 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
1 # NextFlow DSL2 Module
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
2
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
3 ```bash
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
4 ABRICATE_RUN
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
5 ```
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
6
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
7 ## Description
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
8
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
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.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
10
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
11 \
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
12  
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
13
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
14 ### `input:`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
15
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
16 ___
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
17
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
18 Type: `tuple`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
19
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
20 Takes in the following tuple of metadata (`meta`) and a list of assemled contig FASTA files of input type `path` (`assembly`).
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
21
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
22 Ex:
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
23
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
24 ```groovy
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
25 [ [id: 'sample1', single_end: true], '/data/sample1/f_assembly.fa' ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
26 ```
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
27
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
28 \
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
29  
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
30
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
31 #### `meta`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
32
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
33 Type: Groovy Map
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
34
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
35 A Groovy Map containing the metadata about the FASTQ file.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
36
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
37 Ex:
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
38
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
39 ```groovy
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
40 [ id: 'FAL00870', strandedness: 'unstranded', single_end: true ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
41 ```
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
42
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
43 \
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
44  
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
45
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
46 #### `assembly`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
47
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
48 Type: `path`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
49
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
50 NextFlow input type of `path` pointing to assembled contig file in FASTA format.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
51
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
52 \
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
53  
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
54
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
55 #### `abdbs`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
56
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
57 Type: `val`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
58
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
59 Nextflow input type of `val` containing a list of at least one of the following database names on which `abricate` should be run.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
60
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
61 Ex:
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
62
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
63 ```groovy
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
64 [ 'resfinder', 'megares', 'ncbi', 'ncbiamrplus', 'argannot' , 'ecoli_vf' ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
65 ```
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
66
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
67 \
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
68  
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
69
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
70 ### `output:`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
71
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
72 ___
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
73
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
74 Type: `tuple`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
75
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
76 Outputs a tuple of metadata (`meta` from `input:`) and list of `abricate` result files (`abricated`).
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
77
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
78 \
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
79  
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
80
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
81 #### `abricated`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
82
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
83 Type: `path`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
84
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
85 NextFlow output type of `path` pointing to the `abricate` results table file per sample (`id:`).
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
86
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
87 \
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
88  
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
89
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
90 #### `versions`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
91
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
92 Type: `path`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
93
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
94 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.