Mercurial > repos > kkonganti > cfsan_bettercallsal
diff 0.5.0/modules/seqkit/seq/README.md @ 1:365849f031fd
"planemo upload"
author | kkonganti |
---|---|
date | Mon, 05 Jun 2023 18:48:51 -0400 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/0.5.0/modules/seqkit/seq/README.md Mon Jun 05 18:48:51 2023 -0400 @@ -0,0 +1,104 @@ +# NextFlow DSL2 Module + +```bash +SEQKIT_SEQ +``` + +## Description + +Run `seqkit seq` command on reads in FASTQ format. Produces a filtered FASTQ file as per the filter strategy mentioned using the `ext.args` within the process scope. + +\ + + +### `input:` + +___ + +Type: `tuple` + +Takes in the following tuple of metadata (`meta`) and a list of reads of type `path` (`reads`) per sample (`id:`). + +Ex: + +```groovy +[ + [ id: 'FAL00870', + strandedness: 'unstranded', + single_end: true, + centrifuge_x: '/hpc/db/centrifuge/2022-04-12/ab' + ], + '/hpc/scratch/test/FAL000870/f1.merged.fq.gz' +] +``` + +\ + + +#### `meta` + +Type: Groovy Map + +A Groovy Map containing the metadata about the FASTQ file. + +Ex: + +```groovy +[ + id: 'FAL00870', + strandedness: 'unstranded', + single_end: true +] +``` + +\ + + +#### `reads` + +Type: `path` + +NextFlow input type of `path` pointing to FASTQ files on which `seqkit seq` should be run. + +\ + + +#### `args` + +Type: Groovy String + +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. + +Ex: + +```groovy +withName: 'SEQKIT_SEQ' { + ext.args = '--max-len 4000' +} +``` + +### `output:` + +___ + +Type: `tuple` + +Outputs a tuple of metadata (`meta` from `input:`) and filtered gzipped FASTQ file. + +\ + + +#### `fastx` + +Type: `path` + +NextFlow output type of `path` pointing to the FASTQ format filtered gzipped file per sample (`id:`). + +\ + + +#### `versions` + +Type: `path` + +NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.