Mercurial > repos > galaxytrakr > hfp_cronology_awsbatch
diff 0.2.0/modules/mash/sketch/README.md @ 0:9e8b1c747a6a draft default tip
planemo upload
| author | galaxytrakr |
|---|---|
| date | Fri, 29 May 2026 13:32:17 +0000 |
| parents | |
| children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/0.2.0/modules/mash/sketch/README.md Fri May 29 13:32:17 2026 +0000 @@ -0,0 +1,97 @@ +# NextFlow DSL2 Module + +```bash +MASH_SKETCH +``` + +## Description + +Run `mash sketch` on the input FASTQ or FASTA files, gzipped or unzipped. + +\ + + +### `input:` + +___ + +Type: `tuple` + +Takes in the following tuple of metadata (`meta`) and a list of reads of type `path` (`query`) per sample (`id:`). + +Ex: + +```groovy +[ + [ + id: 'FAL00870' + ], + [ + '/hpc/scratch/test/f1.fq.gz' + ] +] +``` + +\ + + +#### `meta` + +Type: Groovy Map + +A Groovy Map containing the metadata about the FASTQ file. + +Ex: + +```groovy +[ + id: 'FAL00870' +] +``` + +\ + + +#### `query` + +Type: `path` + +NextFlow input type of `path` pointing to either FASTQ or FASTA files to be sketched. + +\ + + +### `output:` + +___ + +Type: `tuple` + +Outputs a tuple of metadata (`meta` from `input:`) and `mash sketch` files ending with suffix `.msh`. + +\ + + +#### `sketch` + +Type: `path` + +NextFlow output type of `path` pointing to the sketch (`*.msh`) file per sample (`id:`). + +\ + + +#### `stats` + +Type: `path` + +NextFlow output type of `path` pointing to the log of the `mash sketch` command per sample (`id:`). + +\ + + +#### `versions` + +Type: `path` + +NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.
