Update bwa index docs

software/bwa/index/meta.yml

@@ -1,25 +1,52 @@
-name: bwa index
+name: bwa_index
-description: create indexes for BWA from a fasta file
+description: Create BWA index for reference genome
 keywords:
-    - index
+  - index
+  - fasta
+  - genome
 tools:
-    - bwa:
+  - bwa:
-        description: |
+      description: |
-            BWA is a software package for mapping DNA sequences against a large reference genome, such as the human genome.
+        BWA is a software package for mapping DNA sequences against
-        homepage: http://bio-bwa.sourceforge.net/
+        a large reference genome, such as the human genome.
-        documentation: http://www.htslib.org/doc/samtools.html
+      homepage: http://bio-bwa.sourceforge.net/
-        arxiv: arXiv:1303.3997
+      documentation: http://www.htslib.org/doc/samtools.html
+      arxiv: arXiv:1303.3997
+params:
+  - outdir:
+      type: string
+      description: |
+        The pipeline's output directory. By default, the module will
+        output files into `$params.outdir/<SOFTWARE>`
+  - publish_dir_mode:
+      type: string
+      description: |
+        Value for the Nextflow `publishDir` mode parameter.
+        Available: symlink, rellink, link, copy, copyNoFollow, move.
+  - conda:
+      type: boolean
+      description: |
+        Run the module with Conda using the software specified
+        via the `conda` directive
 input:
-    -
+  - fasta:
-        - input:
+      type: file
-            type: file
+      description: |
-            description: Input fasta file
+        Input genome fasta file
-            pattern: "*.{fasta,fa}"
+  - options:
+      type: map
+      description: |
+        Groovy Map containing module options for passing command-line arguments and
+        output file paths.
 output:
-    -
+  - index:
-        - index:
+      type: file
-            type: file
+      description: BWA genome index files
-            description: bwa indexes file
+      pattern: "*.{fasta}.{amb,ann,bwt,pac,sa}"
-            pattern: "*.{fasta,fa}.{amb,ann,bwt,pac,sa}"
+  - version:
+      type: file
+      description: File containing software version
+      pattern: "*.version.txt"
 authors:
-    - "@maxulysse"
+  - "@drpatelh"
+  - "@maxulysse"