Mercurial > repos > kkonganti > cfsan_bettercallsal

comparison 0.7.0/modules/mash/sketch/README.md @ 17:0e7a0053e4a6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload
author kkonganti
date Mon, 15 Jul 2024 10:42:02 -0400
parents
children
comparison
equal deleted inserted replaced
16:b90e5a7a3d4f 17:0e7a0053e4a6
1 # NextFlow DSL2 Module
2
3 ```bash
4 MASH_SKETCH
5 ```
6
7 ## Description
8
9 Run `mash sketch` on the input FASTQ or FASTA files, gzipped or unzipped.
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` (`query`) per sample (`id:`).
21
22 Ex:
23
24 ```groovy
25 [
26 [
27 id: 'FAL00870'
28 ],
29 [
30 '/hpc/scratch/test/f1.fq.gz'
31 ]
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 ]
50 ```
51
52 \
53  
54
55 #### `query`
56
57 Type: `path`
58
59 NextFlow input type of `path` pointing to either FASTQ or FASTA files to be sketched.
60
61 \
62  
63
64 ### `output:`
65
66 ___
67
68 Type: `tuple`
69
70 Outputs a tuple of metadata (`meta` from `input:`) and `mash sketch` files ending with suffix `.msh`.
71
72 \
73  
74
75 #### `sketch`
76
77 Type: `path`
78
79 NextFlow output type of `path` pointing to the sketch (`*.msh`) file per sample (`id:`).
80
81 \
82  
83
84 #### `stats`
85
86 Type: `path`
87
88 NextFlow output type of `path` pointing to the log of the `mash sketch` command per sample (`id:`).
89
90 \
91  
92
93 #### `versions`
94
95 Type: `path`
96
97 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.