kkonganti@17: # NextFlow DSL2 Module
kkonganti@17: 
kkonganti@17: ```bash
kkonganti@17: MASH_SCREEN
kkonganti@17: ```
kkonganti@17: 
kkonganti@17: ## Description
kkonganti@17: 
kkonganti@17: Run `mash screen` on the input FASTQ file.
kkonganti@17: 
kkonganti@17: \
kkonganti@17:  
kkonganti@17: 
kkonganti@17: ### `input:`
kkonganti@17: 
kkonganti@17: ___
kkonganti@17: 
kkonganti@17: Type: `tuple`
kkonganti@17: 
kkonganti@17: Takes in the following tuple of metadata (`meta`) and a list of reads of type `path` (`query`) per sample (`id:`).
kkonganti@17: 
kkonganti@17: Ex:
kkonganti@17: 
kkonganti@17: ```groovy
kkonganti@17: [ 
kkonganti@17:     [ 
kkonganti@17:         id: 'FAL00870'
kkonganti@17:     ],
kkonganti@17:     [
kkonganti@17:         '/hpc/scratch/test/f1.fq.gz'
kkonganti@17:     ]
kkonganti@17: ]
kkonganti@17: ```
kkonganti@17: 
kkonganti@17: \
kkonganti@17:  
kkonganti@17: 
kkonganti@17: #### `meta`
kkonganti@17: 
kkonganti@17: Type: Groovy Map
kkonganti@17: 
kkonganti@17: A Groovy Map containing the metadata about the FASTQ file.
kkonganti@17: 
kkonganti@17: Ex:
kkonganti@17: 
kkonganti@17: ```groovy
kkonganti@17: [ 
kkonganti@17:     id: 'FAL00870'
kkonganti@17: ]
kkonganti@17: ```
kkonganti@17: 
kkonganti@17: \
kkonganti@17:  
kkonganti@17: 
kkonganti@17: #### `query`
kkonganti@17: 
kkonganti@17: Type: `path`
kkonganti@17: 
kkonganti@17: NextFlow input type of `path` pointing to FASTQ file to be screened.
kkonganti@17: 
kkonganti@17: \
kkonganti@17:  
kkonganti@17: 
kkonganti@17: ### `output:`
kkonganti@17: 
kkonganti@17: ___
kkonganti@17: 
kkonganti@17: Type: `tuple`
kkonganti@17: 
kkonganti@17: Outputs a tuple of metadata (`meta` from `input:`) and `mash screen` result file ending with suffix `.screened`.
kkonganti@17: 
kkonganti@17: \
kkonganti@17:  
kkonganti@17: 
kkonganti@17: #### `screened`
kkonganti@17: 
kkonganti@17: Type: `path`
kkonganti@17: 
kkonganti@17: NextFlow output type of `path` pointing to the result (`*.screened`) of the `mash screen` command per sample (`id:`).
kkonganti@17: 
kkonganti@17: \
kkonganti@17:  
kkonganti@17: 
kkonganti@17: #### `versions`
kkonganti@17: 
kkonganti@17: Type: `path`
kkonganti@17: 
kkonganti@17: NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.