draft API docs for BWA and strelka

1 files changed, 11 insertions, 2 deletions

diff --git a/tools/bwa.nix b/tools/bwa.nix
index d0ab5ee..03735d1 100644
--- a/tools/bwa.nix
+++ b/tools/bwa.nix
@@ -2,7 +2,16 @@
 
 with bionix;
 
-{
-  align = callBionixE ./bwa-mem.nix;
+rec {
+  /* Align read against a reference: defaults to bwa-mem */
+  align = bwa-mem;
+
+  /* Align reads against a reference using bwa-mem
+  Type: bwa-mem :: {ref = fasta, bamOutput = bool, ...} -> {input1, input2} -> bam/sam
+  */
+  bwa-mem = callBionixE ./bwa-mem.nix;
+  /* Creates an reference index for BWA
+  Type: {...} -> fasta -> BWA index
+  */
   index = callBionixE ./bwa-index.nix;
 }