kkonganti@1: # NextFlow DSL2 Module
kkonganti@1: 
kkonganti@1: ```bash
kkonganti@1: GEN_SAMPLESHEET
kkonganti@1: ```
kkonganti@1: 
kkonganti@1: ## Description
kkonganti@1: 
kkonganti@1: Generates a sample sheet in CSV format that contains required fields to be used to construct a Groovy Map of metadata. It requires as input, an absolute UNIX path to a folder containing only FASTQ files. This module requires the `fastq_dir_to_samplesheet.py` script to be present in the `bin` folder from where the NextFlow script including this module will be executed.
kkonganti@1: 
kkonganti@1: \
kkonganti@1:  
kkonganti@1: 
kkonganti@1: ### `input:`
kkonganti@1: 
kkonganti@1: ___
kkonganti@1: 
kkonganti@1: Type: `val`
kkonganti@1: 
kkonganti@1: Takes in the absolute UNIX path to a folder containing only FASTQ files (`inputdir`).
kkonganti@1: 
kkonganti@1: Ex:
kkonganti@1: 
kkonganti@1: ```groovy
kkonganti@1: '/hpc/scratch/test/reads'
kkonganti@1: ```
kkonganti@1: 
kkonganti@1: \
kkonganti@1:  
kkonganti@1: 
kkonganti@1: ### `output:`
kkonganti@1: 
kkonganti@1: ___
kkonganti@1: 
kkonganti@1: Type: `path`
kkonganti@1: 
kkonganti@1: NextFlow output of type `path` pointing to auto-generated CSV sample sheet (`csv`).
kkonganti@1: 
kkonganti@1: \
kkonganti@1:  
kkonganti@1: 
kkonganti@1: #### `csv`
kkonganti@1: 
kkonganti@1: Type: `path`
kkonganti@1: 
kkonganti@1: NextFlow output type of `path` pointing to auto-generated CSV sample sheet for all FASTQ files present in the folder given by NextFlow input type of `val` (`inputdir`).
kkonganti@1: 
kkonganti@1: \
kkonganti@1:  
kkonganti@1: 
kkonganti@1: #### `versions`
kkonganti@1: 
kkonganti@1: Type: `path`
kkonganti@1: 
kkonganti@1: NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.