kkonganti@105: # NextFlow DSL2 Module
kkonganti@105: 
kkonganti@105: ```bash
kkonganti@105: MEGAHIT_ASSEMBLE
kkonganti@105: ```
kkonganti@105: 
kkonganti@105: ## Description
kkonganti@105: 
kkonganti@105: Run `megahit` assembler tool on a list of read files in FASTQ format.
kkonganti@105: 
kkonganti@105: \
kkonganti@105:  
kkonganti@105: 
kkonganti@105: ### `input:`
kkonganti@105: 
kkonganti@105: ___
kkonganti@105: 
kkonganti@105: Type: `tuple`
kkonganti@105: 
kkonganti@105: Takes in the following tuple of metadata (`meta`) and a list of FASTQ files (short reads) of input type `path` (`reads`).
kkonganti@105: 
kkonganti@105: Ex:
kkonganti@105: 
kkonganti@105: ```groovy
kkonganti@105: [ [id: 'sample1', single_end: true], '/data/sample1/f_merged.fq.gz' ]
kkonganti@105: [ [id: 'sample1', single_end: false], ['/data/sample1/f1_merged.fq.gz', '/data/sample2/f2_merged.fq.gz'] ]
kkonganti@105: ```
kkonganti@105: 
kkonganti@105: \
kkonganti@105:  
kkonganti@105: 
kkonganti@105: #### `meta`
kkonganti@105: 
kkonganti@105: Type: Groovy Map
kkonganti@105: 
kkonganti@105: A Groovy Map containing the metadata about the FASTQ file.
kkonganti@105: 
kkonganti@105: Ex:
kkonganti@105: 
kkonganti@105: ```groovy
kkonganti@105: [ id: 'KB01', strandedness: 'unstranded', single_end: true ]
kkonganti@105: ```
kkonganti@105: 
kkonganti@105: \
kkonganti@105:  
kkonganti@105: 
kkonganti@105: #### `reads`
kkonganti@105: 
kkonganti@105: Type: `path`
kkonganti@105: 
kkonganti@105: NextFlow input type of `path` pointing to short read files in FASTQ format that need to be *de novo* assembled.
kkonganti@105: 
kkonganti@105: \
kkonganti@105:  
kkonganti@105: 
kkonganti@105: #### `args`
kkonganti@105: 
kkonganti@105: Type: Groovy String
kkonganti@105: 
kkonganti@105: 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@105: 
kkonganti@105: Ex:
kkonganti@105: 
kkonganti@105: ```groovy
kkonganti@105: withName: 'MEGAHIT_ASSEMBLE' {
kkonganti@105:     ext.args = '--keep-tmp-files'
kkonganti@105: }
kkonganti@105: ```
kkonganti@105: 
kkonganti@105: \
kkonganti@105:  
kkonganti@105: 
kkonganti@105: ### `output:`
kkonganti@105: 
kkonganti@105: ___
kkonganti@105: 
kkonganti@105: Type: `tuple`
kkonganti@105: 
kkonganti@105: Outputs a tuple of metadata (`meta` from `input:`) and `megahit` assembled contigs file in FASTA format.
kkonganti@105: 
kkonganti@105: \
kkonganti@105:  
kkonganti@105: 
kkonganti@105: #### `assembly`
kkonganti@105: 
kkonganti@105: Type: `path`
kkonganti@105: 
kkonganti@105: NextFlow output type of `path` pointing to the `megahit` assembler results file (`final.contigs.fa`) per sample (`id:`) i.e., the final assembled contigs file in FASTA format.
kkonganti@105: 
kkonganti@105: \
kkonganti@105:  
kkonganti@105: 
kkonganti@105: #### `versions`
kkonganti@105: 
kkonganti@105: Type: `path`
kkonganti@105: 
kkonganti@105: NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.