diff 0.4.0/modules/kraken2/classify/README.md @ 104:17890124001d

"planemo upload"
author kkonganti
date Sun, 28 Aug 2022 00:37:10 -0400
parents ce6d9548fe89
children
line wrap: on
line diff
--- a/0.4.0/modules/kraken2/classify/README.md	Thu Aug 04 10:58:46 2022 -0400
+++ b/0.4.0/modules/kraken2/classify/README.md	Sun Aug 28 00:37:10 2022 -0400
@@ -17,7 +17,7 @@
 
 Type: `tuple`
 
-Takes in the following tuple of metadata (`meta`) and a list of reads of type `path` (`reads`) per sample (`id:`).
+Takes in the following tuple of metadata (`meta`) and a list of reads or FASTA assembly of type `path` (`reads`) per sample (`id:`).
 
 Ex:
 
@@ -26,7 +26,9 @@
     [ id: 'FAL00870',
        strandedness: 'unstranded',
        single_end: true,
+       is_assembly: false,
        centrifuge_x: '/hpc/db/centrifuge/2022-04-12/ab'
+       kraken2_db: '/hpc/db/kraken2/standard-210914',
     ],
     '/hpc/scratch/test/FAL000870/f1.merged.fq.gz'
 ]
@@ -39,7 +41,7 @@
 
 Type: Groovy Map
 
-A Groovy Map containing the metadata about the FASTQ file.
+A Groovy Map containing the metadata about the FASTQ / FASTA file.
 
 Ex:
 
@@ -48,6 +50,7 @@
     id: 'FAL00870',
     strandedness: 'unstranded',
     single_end: true,
+    is_assembly: false,
     kraken2_db: '/hpc/db/kraken2/standard-210914'
 ]
 ```