Mercurial > repos > kkonganti > cfsan_bettercallsal

comparison 0.5.0/modules/seqkit/seq/README.md @ 1:365849f031fd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload"
author kkonganti
date Mon, 05 Jun 2023 18:48:51 -0400
parents
children
comparison
equal deleted inserted replaced
0:a4b1ee4b68b1 1:365849f031fd
1 # NextFlow DSL2 Module
2
3 ```bash
4 SEQKIT_SEQ
5 ```
6
7 ## Description
8
9 Run `seqkit seq` command on reads in FASTQ format. Produces a filtered FASTQ file as per the filter strategy mentioned using the `ext.args` within the process scope.
10
11 \
12  
13
14 ### `input:`
15
16 ___
17
18 Type: `tuple`
19
20 Takes in the following tuple of metadata (`meta`) and a list of reads of type `path` (`reads`) per sample (`id:`).
21
22 Ex:
23
24 ```groovy
25 [
26 [ id: 'FAL00870',
27 strandedness: 'unstranded',
28 single_end: true,
29 centrifuge_x: '/hpc/db/centrifuge/2022-04-12/ab'
30 ],
31 '/hpc/scratch/test/FAL000870/f1.merged.fq.gz'
32 ]
33 ```
34
35 \
36  
37
38 #### `meta`
39
40 Type: Groovy Map
41
42 A Groovy Map containing the metadata about the FASTQ file.
43
44 Ex:
45
46 ```groovy
47 [
48 id: 'FAL00870',
49 strandedness: 'unstranded',
50 single_end: true
51 ]
52 ```
53
54 \
55  
56
57 #### `reads`
58
59 Type: `path`
60
61 NextFlow input type of `path` pointing to FASTQ files on which `seqkit seq` should be run.
62
63 \
64  
65
66 #### `args`
67
68 Type: Groovy String
69
70 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.
71
72 Ex:
73
74 ```groovy
75 withName: 'SEQKIT_SEQ' {
76 ext.args = '--max-len 4000'
77 }
78 ```
79
80 ### `output:`
81
82 ___
83
84 Type: `tuple`
85
86 Outputs a tuple of metadata (`meta` from `input:`) and filtered gzipped FASTQ file.
87
88 \
89  
90
91 #### `fastx`
92
93 Type: `path`
94
95 NextFlow output type of `path` pointing to the FASTQ format filtered gzipped file per sample (`id:`).
96
97 \
98  
99
100 #### `versions`
101
102 Type: `path`
103
104 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.