api docs: init ascatNGS

1 files changed, 8 insertions, 0 deletions

diff --git a/tools/ascat.nix b/tools/ascat.nix
index 05e2299..9e80e4a 100644
--- a/tools/ascat.nix
+++ b/tools/ascat.nix
@@ -4,6 +4,14 @@ with bionix;
 
 {
   app = pkgs.callPackage ./ascat-app.nix {};
+
+  /* Generate GC correction file for ascatNGS.
+  Type: {ref :: fasta, chrPrefix :: string, ...} -> (snps :: VCF) -> (gc :: GC)
+  */
   gccorrect = callBionixE ./ascat-gccorrect.nix;
+
+  /* Call CNVs using ascatNGS. Gender is a string as per ascatNGS docs (e.g., "XX").
+  Type: {ref :: fasta, gc :: GC, ...} -> {tumour :: bam, normal :: bam, gender :: string} -> CNVs
+  */
   callCNV = callBionixE ./ascat-callCNV.nix;
 }