annotate 0.4.2/modules/flye/assemble/README.md @ 0:082e0091e813 draft default tip

planemo upload
author galaxytrakr
date Fri, 29 May 2026 13:27:47 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
1 # NextFlow DSL2 Module
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
2
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
3 ```bash
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
4 FLYE_ASSEMBLE
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
5 ```
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
6
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
7 ## Description
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
8
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
9 Run `flye` assembler tool on a list of read files in FASTQ format.
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
10
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
11 \
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
12  
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
13
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
14 ### `input:`
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
15
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
16 ___
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
17
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
18 Type: `tuple`
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
19
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
20 Takes in the following tuple of metadata (`meta`) and a list of FASTQ files of input type `path` (`reads`).
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
21
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
22 Ex:
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
23
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
24 ```groovy
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
25 [ [id: 'sample1', single_end: true], '/data/sample1/f_merged.fq.gz' ]
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
26 ```
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
27
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
28 \
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
29  
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
30
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
31 #### `meta`
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
32
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
33 Type: Groovy Map
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
34
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
35 A Groovy Map containing the metadata about the FASTQ file.
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
36
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
37 Ex:
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
38
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
39 ```groovy
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
40 [ id: 'FAL00870', strandedness: 'unstranded', single_end: true ]
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
41 ```
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
42
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
43 \
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
44  
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
45
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
46 #### `reads`
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
47
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
48 Type: `path`
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
49
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
50 NextFlow input type of `path` pointing to read files in FASTQ format that need to be *de novo* assembled.
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
51
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
52 \
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
53  
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
54
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
55 #### `args`
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
56
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
57 Type: Groovy String
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
58
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
59 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.
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
60
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
61 Ex:
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
62
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
63 ```groovy
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
64 withName: 'FLYE_ASSEMBLE' {
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
65 ext.args = '--casava'
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
66 }
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
67 ```
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
68
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
69 \
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
70  
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
71
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
72 ### `output:`
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
73
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
74 ___
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
75
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
76 Type: `tuple`
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
77
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
78 Outputs a tuple of metadata (`meta` from `input:`) and `flye` assembled contig file in FASTA format.
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
79
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
80 \
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
81  
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
82
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
83 #### `assembly`
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
84
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
85 Type: `path`
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
86
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
87 NextFlow output type of `path` pointing to the `flye` assembler results file per sample (`id:`) i.e., the final assembled contig file in FASTA format.
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
88
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
89 \
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
90  
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
91
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
92 #### `versions`
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
93
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
94 Type: `path`
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
95
082e0091e813 planemo upload
galaxytrakr
parents:
diff changeset
96 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.