From d52ef1a0189015ea463628391e8877bc0c1d11a5 Mon Sep 17 00:00:00 2001
From: Justin Bedo <cu@cua0.org>
Date: Wed, 6 Mar 2019 13:35:41 +1100
Subject: api doc: init fastqc

---
 doc/tools-doc.nix | 1 +
 doc/tools.xml     | 1 +
 tools/fastqc.nix  | 4 ++++
 3 files changed, 6 insertions(+)

diff --git a/doc/tools-doc.nix b/doc/tools-doc.nix
index 5ee8e22..f52f6ad 100644
--- a/doc/tools-doc.nix
+++ b/doc/tools-doc.nix
@@ -29,6 +29,7 @@ stage {
     docgen bwa 'BWA aligner'
     docgen cnvkit 'CNVkit CNV caller'
     docgen facets 'Facets CNV caller'
+    docgen fastqc 'FastQC quality control'
     docgen strelka 'Strelka2 variant caller'
 
     mkdir $out
diff --git a/doc/tools.xml b/doc/tools.xml
index 33a053b..2592b48 100644
--- a/doc/tools.xml
+++ b/doc/tools.xml
@@ -13,6 +13,7 @@
   <xi:include href="bwa.xml" />
   <xi:include href="cnvkit.xml" />
   <xi:include href="facets.xml" />
+  <xi:include href="fastqc.xml" />
   <xi:include href="strelka.xml" />
  </section>
 </book>
diff --git a/tools/fastqc.nix b/tools/fastqc.nix
index 5632958..6279682 100644
--- a/tools/fastqc.nix
+++ b/tools/fastqc.nix
@@ -4,5 +4,9 @@ with bionix;
 
 {
   fastqc = pkgs.callPackage ./fastqc-app.nix {};
+
+  /* QC check
+  Type: check :: {...} -> input :: fastq -> report
+  */
   check = callBionixE ./fastqc-check.nix;
 }
-- 
cgit v1.2.3