kkonganti@101: # NextFlow DSL2 Module
kkonganti@101: 
kkonganti@101: ```bash
kkonganti@101: MLST
kkonganti@101: ```
kkonganti@101: 
kkonganti@101: ## Description
kkonganti@101: 
kkonganti@101: Run `mlst` tool on a list of assembled contigs in FASTA format. Produces a single output table in ASCII text format.
kkonganti@101: 
kkonganti@101: \
kkonganti@101:  
kkonganti@101: 
kkonganti@101: ### `input:`
kkonganti@101: 
kkonganti@101: ___
kkonganti@101: 
kkonganti@101: Type: `tuple`
kkonganti@101: 
kkonganti@101: Takes in the following tuple of metadata (`meta`) and a list of assemled contig FASTA files of input type `path` (`fasta`).
kkonganti@101: 
kkonganti@101: Ex:
kkonganti@101: 
kkonganti@101: ```groovy
kkonganti@101: [ [id: 'sample1', single_end: true], '/data/sample1/f_assembly.fa' ]
kkonganti@101: ```
kkonganti@101: 
kkonganti@101: \
kkonganti@101:  
kkonganti@101: 
kkonganti@101: #### `meta`
kkonganti@101: 
kkonganti@101: Type: Groovy Map
kkonganti@101: 
kkonganti@101: A Groovy Map containing the metadata about the FASTQ file.
kkonganti@101: 
kkonganti@101: Ex:
kkonganti@101: 
kkonganti@101: ```groovy
kkonganti@101: [ id: 'FAL00870', strandedness: 'unstranded', single_end: true ]
kkonganti@101: ```
kkonganti@101: 
kkonganti@101: \
kkonganti@101:  
kkonganti@101: 
kkonganti@101: #### `fasta`
kkonganti@101: 
kkonganti@101: Type: `path`
kkonganti@101: 
kkonganti@101: NextFlow input type of `path` pointing to assembled contig file in FASTA format.
kkonganti@101: 
kkonganti@101: \
kkonganti@101:  
kkonganti@101: 
kkonganti@101: #### `args`
kkonganti@101: 
kkonganti@101: Type: Groovy String
kkonganti@101: 
kkonganti@101: 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@101: 
kkonganti@101: Ex:
kkonganti@101: 
kkonganti@101: ```groovy
kkonganti@101: withName: 'MLST' {
kkonganti@101:     ext.args = '--nopath'
kkonganti@101: }
kkonganti@101: ```
kkonganti@101: 
kkonganti@101: \
kkonganti@101:  
kkonganti@101: 
kkonganti@101: ### `output:`
kkonganti@101: 
kkonganti@101: ___
kkonganti@101: 
kkonganti@101: Type: `tuple`
kkonganti@101: 
kkonganti@101: Outputs a tuple of metadata (`meta` from `input:`) and list of `mlst` result files (`tsv`).
kkonganti@101: 
kkonganti@101: \
kkonganti@101:  
kkonganti@101: 
kkonganti@101: #### `tsv`
kkonganti@101: 
kkonganti@101: Type: `path`
kkonganti@101: 
kkonganti@101: NextFlow output type of `path` pointing to the `mlst` results table file per sample (`id:`).
kkonganti@101: 
kkonganti@101: \
kkonganti@101:  
kkonganti@101: 
kkonganti@101: #### `versions`
kkonganti@101: 
kkonganti@101: Type: `path`
kkonganti@101: 
kkonganti@101: NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.