api docs: init facets

2 files changed, 6 insertions, 2 deletions

diff --git a/tools/ascat.nix b/tools/ascat.nix
index 9e80e4a..700cb4e 100644
--- a/tools/ascat.nix
+++ b/tools/ascat.nix
@@ -6,12 +6,12 @@ with bionix;
   app = pkgs.callPackage ./ascat-app.nix {};
 
   /* Generate GC correction file for ascatNGS.
-  Type: {ref :: fasta, chrPrefix :: string, ...} -> (snps :: VCF) -> (gc :: GC)
+  Type: gccorrect :: {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
+  Type: callCNV :: {ref :: fasta, gc :: GC, ...} -> {tumour :: bam, normal :: bam, gender :: string} -> CNVs
   */
   callCNV = callBionixE ./ascat-callCNV.nix;
 }
diff --git a/tools/facets.nix b/tools/facets.nix
index ed10ffa..523c72a 100644
--- a/tools/facets.nix
+++ b/tools/facets.nix
@@ -4,5 +4,9 @@ with bionix;
 
 {
   app = lib.callPackageWith (pkgs // pkgs.rPackages) ./facets-app.nix {};
+
+  /* Call CNVs
+  Type: callCnv :: {...} -> {vcf, bams :: [bams]} -> CNVs
+  */
   callCNV = callBionix ./facets-call.nix;
 }