kkonganti@0: # NextFlow DSL2 Module
kkonganti@0: 
kkonganti@0: ```bash
kkonganti@0: KMA_ALIGN
kkonganti@0: ```
kkonganti@0: 
kkonganti@0: ## Description
kkonganti@0: 
kkonganti@0: Run `kma` alinger on input FASTQ files with a pre-formatted `kma` index.
kkonganti@0: 
kkonganti@0: \
kkonganti@0:  
kkonganti@0: 
kkonganti@0: ### `input:`
kkonganti@0: 
kkonganti@0: ___
kkonganti@0: 
kkonganti@0: Type: `tuple`
kkonganti@0: 
kkonganti@0: Takes in the following tuple of metadata (`meta`) and a list of reads of type `path` (`reads`) and a correspondonding `kma` pre-formatted index folder per sample (`id:`).
kkonganti@0: 
kkonganti@0: Ex:
kkonganti@0: 
kkonganti@0: ```groovy
kkonganti@0: [ 
kkonganti@0:     [ 
kkonganti@0:         id: 'FAL00870',
kkonganti@0:         strandedness: 'unstranded',
kkonganti@0:         single_end: false
kkonganti@0:     ],
kkonganti@0:     [
kkonganti@0:         '/hpc/scratch/test/f1.R1.fq.gz',
kkonganti@0:         '/hpc/scratch/test/f1.R2.fq.gz'
kkonganti@0:     ],
kkonganti@0:     '/path/to/kma/index/folder'
kkonganti@0: ]
kkonganti@0: ```
kkonganti@0: 
kkonganti@0: \
kkonganti@0:  
kkonganti@0: 
kkonganti@0: #### `meta`
kkonganti@0: 
kkonganti@0: Type: Groovy Map
kkonganti@0: 
kkonganti@0: A Groovy Map containing the metadata about the FASTQ file.
kkonganti@0: 
kkonganti@0: Ex:
kkonganti@0: 
kkonganti@0: ```groovy
kkonganti@0: [ 
kkonganti@0:     id: 'FAL00870',
kkonganti@0:     strandedness: 'unstranded',
kkonganti@0:     single_end: true
kkonganti@0: ]
kkonganti@0: ```
kkonganti@0: 
kkonganti@0: \
kkonganti@0:  
kkonganti@0: 
kkonganti@0: #### `reads`
kkonganti@0: 
kkonganti@0: Type: `path`
kkonganti@0: 
kkonganti@0: NextFlow input type of `path` pointing to paired-end FASTQ files on which `bbmerge.sh` should be run.
kkonganti@0: 
kkonganti@0: \
kkonganti@0:  
kkonganti@0: 
kkonganti@0: #### `index`
kkonganti@0: 
kkonganti@0: Type: `path`
kkonganti@0: 
kkonganti@0: NextFlow input type of `path` pointing to folder containing `kma` index files.
kkonganti@0: 
kkonganti@0: \
kkonganti@0:  
kkonganti@0: 
kkonganti@0: #### `args`
kkonganti@0: 
kkonganti@0: Type: Groovy String
kkonganti@0: 
kkonganti@0: 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.
kkonganti@0: 
kkonganti@0: Ex:
kkonganti@0: 
kkonganti@0: ```groovy
kkonganti@0: withName: 'KMA_ALIGN' {
kkonganti@0:     ext.args = '-mint2'
kkonganti@0: }
kkonganti@0: ```
kkonganti@0: 
kkonganti@0: ### `output:`
kkonganti@0: 
kkonganti@0: ___
kkonganti@0: 
kkonganti@0: Type: `tuple`
kkonganti@0: 
kkonganti@0: Outputs a tuple of metadata (`meta` from `input:`) and `kma` result files.
kkonganti@0: 
kkonganti@0: \
kkonganti@0:  
kkonganti@0: 
kkonganti@0: #### `res`
kkonganti@0: 
kkonganti@0: Type: `path`
kkonganti@0: 
kkonganti@0: NextFlow output type of `path` pointing to the `.res` file from `kma` per sample (`id:`).
kkonganti@0: 
kkonganti@0: \
kkonganti@0:  
kkonganti@0: 
kkonganti@0: #### `mapstat`
kkonganti@0: 
kkonganti@0: Type: `path`
kkonganti@0: 
kkonganti@0: NextFlow output type of `path` pointing to the `.map` file from `kma` per sample (`id:`). Optional: `true`
kkonganti@0: 
kkonganti@0: \
kkonganti@0:  
kkonganti@0: 
kkonganti@0: #### `hits`
kkonganti@0: 
kkonganti@0: Type: `path`
kkonganti@0: 
kkonganti@0: NextFlow output type of `path` pointing to a `*_template_hits.txt` file containing only hit IDs. Optional: `true`
kkonganti@0: 
kkonganti@0: \
kkonganti@0:  
kkonganti@0: 
kkonganti@0: #### `versions`
kkonganti@0: 
kkonganti@0: Type: `path`
kkonganti@0: 
kkonganti@0: NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.