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

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