kkonganti@0: # NextFlow DSL2 Module
kkonganti@0: 
kkonganti@0: ```bash
kkonganti@0: ABRICATE_RUN
kkonganti@0: ```
kkonganti@0: 
kkonganti@0: ## Description
kkonganti@0: 
kkonganti@0: Run `abricate` tool on a list of assembled contigs in FASTA format given a list of database names. Produces a single output table in ASCII text format per database.
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 assemled contig FASTA files of input type `path` (`assembly`).
kkonganti@0: 
kkonganti@0: Ex:
kkonganti@0: 
kkonganti@0: ```groovy
kkonganti@0: [ [id: 'sample1', single_end: true], '/data/sample1/f_assembly.fa' ]
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: [ id: 'FAL00870', strandedness: 'unstranded', single_end: true ]
kkonganti@0: ```
kkonganti@0: 
kkonganti@0: \
kkonganti@0:  
kkonganti@0: 
kkonganti@0: #### `assembly`
kkonganti@0: 
kkonganti@0: Type: `path`
kkonganti@0: 
kkonganti@0: NextFlow input type of `path` pointing to assembled contig file in FASTA format.
kkonganti@0: 
kkonganti@0: \
kkonganti@0:  
kkonganti@0: 
kkonganti@0: #### `abdbs`
kkonganti@0: 
kkonganti@0: Type: `val`
kkonganti@0: 
kkonganti@0: Nextflow input type of `val` containing a list of at least one of the following database names on which `abricate` should be run.
kkonganti@0: 
kkonganti@0: Ex:
kkonganti@0: 
kkonganti@0: ```groovy
kkonganti@0: [ 'resfinder', 'megares', 'ncbi', 'ncbiamrplus', 'argannot' , 'ecoli_vf' ]
kkonganti@0: ```
kkonganti@0: 
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 list of `abricate` result files (`abricated`).
kkonganti@0: 
kkonganti@0: \
kkonganti@0:  
kkonganti@0: 
kkonganti@0: #### `abricated`
kkonganti@0: 
kkonganti@0: Type: `path`
kkonganti@0: 
kkonganti@0: NextFlow output type of `path` pointing to the `abricate` results table file per sample (`id:`).
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.