annotate 1.0.0/modules/flye/assemble/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 FLYE_ASSEMBLE
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 `flye` assembler tool on a list of read files in FASTQ format.
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 FASTQ files of input type `path` (`reads`).
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_merged.fq.gz' ]
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 #### `reads`
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 read files in FASTQ format that need to be *de novo* assembled.
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 #### `args`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
56
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
57 Type: Groovy String
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
58
0a8dda29956e 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.
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 withName: 'FLYE_ASSEMBLE' {
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
65 ext.args = '--casava'
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  
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
71
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
72 ### `output:`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
73
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
74 ___
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
75
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
76 Type: `tuple`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
77
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
78 Outputs a tuple of metadata (`meta` from `input:`) and `flye` assembled contig file in FASTA format.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
79
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
80 \
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
81  
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
82
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
83 #### `assembly`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
84
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
85 Type: `path`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
86
0a8dda29956e 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.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
88
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
89 \
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
90  
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
91
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
92 #### `versions`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
93
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
94 Type: `path`
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
95
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
96 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.