kkonganti@101: # NextFlow DSL2 Module
kkonganti@101: 
kkonganti@101: ```bash
kkonganti@101: CENTRIFUGE_PROCESS
kkonganti@101: ```
kkonganti@101: 
kkonganti@101: ## Description
kkonganti@101: 
kkonganti@101: Extract FASTQ reads given a FASTQ file originally used with `centrifuge` tool and a taxa of interest. This specific module uses a `python` script to generate the FASTQ read ids and as such requires a `bin` folder with `process_centrifuge_output.py` to be present where the NextFlow script will be executed from. See also `CENTRIFUGE_EXTRACT` module which uses only GNU Coreutils to create a list of FASTQ read ids that need to be extracted.
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 a tuple in order of metadata (`meta`), a `path` (`centrifuge_report`) type and another `path` (`centrifuge_report`) per sample (`id:`).
kkonganti@101: 
kkonganti@101: Ex:
kkonganti@101: 
kkonganti@101: ```groovy
kkonganti@101: [ 
kkonganti@101:     [ id: 'FAL00870',
kkonganti@101:        strandedness: 'unstranded',
kkonganti@101:        single_end: true,
kkonganti@101:        centrifuge_x: '/hpc/db/centrifuge/2022-04-12/ab'
kkonganti@101:     ],
kkonganti@101:     '/hpc/scratch/test/FAL000870/f1.merged.cent_out.report.txt',
kkonganti@101:     '/hpc/scratch/test/FAL000870/f1.merged.cent_out.output.txt'
kkonganti@101: ]
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: [ 
kkonganti@101:     id: 'FAL00870',
kkonganti@101:     strandedness: 'unstranded',
kkonganti@101:     single_end: true,
kkonganti@101:     centrifuge_x: '/hpc/db/centrifuge/2022-04-12/ab'
kkonganti@101: ]
kkonganti@101: ```
kkonganti@101: 
kkonganti@101: \
kkonganti@101:  
kkonganti@101: 
kkonganti@101: #### `centrifuge_report`
kkonganti@101: 
kkonganti@101: Type: `path`
kkonganti@101: 
kkonganti@101: NextFlow input type of `path` pointing to `centrifuge` report file generated using `--report-file` option of `centrifuge` tool.
kkonganti@101: 
kkonganti@101: \
kkonganti@101:  
kkonganti@101: 
kkonganti@101: #### `centrifuge_output`
kkonganti@101: 
kkonganti@101: Type: `path`
kkonganti@101: 
kkonganti@101: NextFlow input type of `path` pointing to `centrifuge` output file generated using `-S` option of `centrifuge` tool.
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 extracted FASTQ read ids.
kkonganti@101: 
kkonganti@101: \
kkonganti@101:  
kkonganti@101: 
kkonganti@101: #### `extracted`
kkonganti@101: 
kkonganti@101: Type: `path`
kkonganti@101: 
kkonganti@101: NextFlow output type of `path` pointing to the extracted FASTQ read ids belonging to a particular taxa (`*.extract-centrifuge-bug-ids.txt`).
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.