Transferred docs from documentation branch

sanger-tol · Nov 15, 2023 · 9f369b7 · 9f369b7
1 parent 9a2dc32
commit 9f369b7
Show file tree

Hide file tree

Showing 23 changed files with 2,138 additions and 150 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/README.md b/docs/README.md
@@ -5,4 +5,4 @@ The sanger-tol/genomeassembly documentation is split into the following pages:
 - [Usage](usage.md)
   - An overview of how the pipeline works, how to run it and a description of all of the different command-line flags.
 - [Output](output.md)
-  - An overview of the different results produced by the pipeline and how to interpret them.
+  - An overview of the pipeline structure, the description results produced by it and how to interpret them.
diff --git a/docs/images/mqc_fastqc_adapter.png b/docs/images/mqc_fastqc_adapter.png
diff --git a/docs/images/mqc_fastqc_counts.png b/docs/images/mqc_fastqc_counts.png
diff --git a/docs/images/mqc_fastqc_quality.png b/docs/images/mqc_fastqc_quality.png
diff --git a/docs/images/v1/genome_statistics.drawio b/docs/images/v1/genome_statistics.drawio
@@ -0,0 +1,143 @@
+<mxfile host="app.diagrams.net" modified="2023-11-15T09:52:29.435Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36" etag="parKIF83_5zZ88P2X0ZS" version="22.1.0" type="device">
+  <diagram name="Page-1" id="eF7tXEJZUrHQdcSFM5dA">
+    <mxGraphModel dx="1509" dy="839" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" math="0" shadow="0">
+      <root>
+        <mxCell id="0" />
+        <mxCell id="1" parent="0" />
+        <mxCell id="XOOXr_gw0LySKT0VeDug-1" value="" style="group;aspect=fixed;" vertex="1" connectable="0" parent="1">
+          <mxGeometry x="140" y="130" width="70" height="77.78" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-2" value="" style="shape=note;whiteSpace=wrap;html=1;backgroundOutline=1;darkOpacity=0.05;rounded=1;size=20;strokeWidth=2;" vertex="1" parent="XOOXr_gw0LySKT0VeDug-1">
+          <mxGeometry x="3.888888888888889" width="62.22222222222222" height="77.78" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-3" value="&lt;font size=&quot;1&quot; face=&quot;Maven Pro&quot; color=&quot;#ffffff&quot;&gt;&lt;b style=&quot;font-size: 14px;&quot;&gt;Primary assembly&lt;/b&gt;&lt;/font&gt;" style="rounded=1;whiteSpace=wrap;html=1;strokeWidth=2;fillColor=#000000;" vertex="1" parent="XOOXr_gw0LySKT0VeDug-1">
+          <mxGeometry y="31.112000000000002" width="70" height="31.112000000000002" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-13" value="" style="group;aspect=fixed;" vertex="1" connectable="0" parent="1">
+          <mxGeometry x="143" y="432" width="75" height="82.89" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-14" value="" style="shape=note;whiteSpace=wrap;html=1;backgroundOutline=1;darkOpacity=0.05;rounded=1;size=20;strokeWidth=2;" vertex="1" parent="XOOXr_gw0LySKT0VeDug-13">
+          <mxGeometry x="3.947368421052632" width="63.15789473684211" height="78.94285714285715" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-15" value="&lt;font data-font-src=&quot;https://fonts.googleapis.com/css?family=Maven+Pro&quot; face=&quot;Maven Pro&quot; color=&quot;#ffffff&quot;&gt;&lt;b&gt;&lt;font style=&quot;font-size: 20px;&quot;&gt;Fastq&lt;/font&gt;&lt;/b&gt;&lt;/font&gt;" style="rounded=1;whiteSpace=wrap;html=1;strokeWidth=2;fillColor=#000000;" vertex="1" parent="XOOXr_gw0LySKT0VeDug-13">
+          <mxGeometry y="31.57714285714286" width="71.05263157894737" height="31.57714285714286" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-16" value="" style="shape=note;whiteSpace=wrap;html=1;backgroundOutline=1;darkOpacity=0.05;rounded=1;size=20;strokeWidth=2;" vertex="1" parent="XOOXr_gw0LySKT0VeDug-13">
+          <mxGeometry x="7.894736842105264" y="3.9471428571428575" width="63.15789473684211" height="78.94285714285715" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-17" value="&lt;font data-font-src=&quot;https://fonts.googleapis.com/css?family=Maven+Pro&quot; face=&quot;Maven Pro&quot; color=&quot;#ffffff&quot;&gt;&lt;b&gt;&lt;font style=&quot;font-size: 15px;&quot;&gt;FastK database&lt;/font&gt;&lt;/b&gt;&lt;/font&gt;" style="rounded=1;whiteSpace=wrap;html=1;strokeWidth=2;fillColor=#000000;" vertex="1" parent="XOOXr_gw0LySKT0VeDug-13">
+          <mxGeometry x="3.947368421052632" y="35.52428571428572" width="71.05263157894737" height="31.57714285714286" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-20" value="gfastats pri" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
+          <mxGeometry x="261" y="82" width="60" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-22" value="gfastats alt" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
+          <mxGeometry x="260" y="196" width="60" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-31" value="" style="endArrow=none;html=1;rounded=1;strokeWidth=2;exitX=1;exitY=0.5;exitDx=0;exitDy=0;fillColor=#60a917;strokeColor=#2D7600;" edge="1" parent="1">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="210" y="285" as="sourcePoint" />
+            <mxPoint x="290" y="245" as="targetPoint" />
+            <Array as="points">
+              <mxPoint x="270" y="285" />
+              <mxPoint x="290" y="265" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-32" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;rounded=1;rotation=0;strokeWidth=2;" vertex="1" parent="1">
+          <mxGeometry x="280" y="233" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-34" value="" style="endArrow=none;html=1;rounded=1;strokeWidth=2;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" edge="1" parent="1">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="210" y="170" as="sourcePoint" />
+            <mxPoint x="290" y="130" as="targetPoint" />
+            <Array as="points">
+              <mxPoint x="270" y="170" />
+              <mxPoint x="290" y="150" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-35" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;rounded=1;rotation=0;strokeWidth=2;" vertex="1" parent="1">
+          <mxGeometry x="280" y="120" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-39" value="" style="endArrow=none;html=1;rounded=1;strokeWidth=2;exitX=0.985;exitY=0.408;exitDx=0;exitDy=0;exitPerimeter=0;" edge="1" parent="1" source="XOOXr_gw0LySKT0VeDug-3">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="321" y="175" as="sourcePoint" />
+            <mxPoint x="401" y="135" as="targetPoint" />
+            <Array as="points">
+              <mxPoint x="381" y="175" />
+              <mxPoint x="401" y="155" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-41" value="BUSCO" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
+          <mxGeometry x="371" y="90" width="60" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-43" value="" style="endArrow=none;html=1;rounded=1;strokeWidth=2;exitX=1;exitY=0.25;exitDx=0;exitDy=0;fillColor=#d80073;strokeColor=#A50040;entryX=1;entryY=1;entryDx=0;entryDy=0;" edge="1" parent="1" target="XOOXr_gw0LySKT0VeDug-54">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="211.5" y="377.52" as="sourcePoint" />
+            <mxPoint x="407.0710678118653" y="144.07106781186542" as="targetPoint" />
+            <Array as="points">
+              <mxPoint x="331.5" y="377.52" />
+              <mxPoint x="386.5" y="377.52" />
+              <mxPoint x="406.5" y="357.52" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-45" value="" style="endArrow=none;html=1;rounded=1;strokeWidth=2;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="210" y="184.74" as="sourcePoint" />
+            <mxPoint x="585.0000000000001" y="184.99999999999994" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-46" value="" style="endArrow=none;html=1;rounded=1;strokeWidth=2;exitX=0.892;exitY=-0.012;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;exitPerimeter=0;fillColor=#60a917;strokeColor=#2D7600;" edge="1" parent="1" target="XOOXr_gw0LySKT0VeDug-55">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="200.27999999999997" y="275.52" as="sourcePoint" />
+            <mxPoint x="595" y="163" as="targetPoint" />
+            <Array as="points">
+              <mxPoint x="575" y="276" />
+              <mxPoint x="595" y="256" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-47" value="" style="endArrow=none;html=1;rounded=1;strokeWidth=2;exitX=1;exitY=0;exitDx=0;exitDy=0;fillColor=#fa6800;strokeColor=#C73500;entryX=1;entryY=1;entryDx=0;entryDy=0;" edge="1" parent="1" target="XOOXr_gw0LySKT0VeDug-55">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="219" y="491" as="sourcePoint" />
+            <mxPoint x="602.3600000000001" y="131.64" as="targetPoint" />
+            <Array as="points">
+              <mxPoint x="584" y="491" />
+              <mxPoint x="604" y="471" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-48" value="MerquryFK" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
+          <mxGeometry x="565" y="140" width="60" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-51" value="" style="group;aspect=fixed;" vertex="1" connectable="0" parent="1">
+          <mxGeometry x="144" y="327" width="70" height="77.78" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-52" value="" style="shape=note;whiteSpace=wrap;html=1;backgroundOutline=1;darkOpacity=0.05;rounded=1;size=20;strokeWidth=2;" vertex="1" parent="XOOXr_gw0LySKT0VeDug-51">
+          <mxGeometry x="3.888888888888889" width="62.22222222222222" height="77.78" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-53" value="&lt;font size=&quot;1&quot; face=&quot;Maven Pro&quot; color=&quot;#ffffff&quot;&gt;&lt;b style=&quot;&quot;&gt;Path to BUSCO lineage&lt;/b&gt;&lt;/font&gt;" style="rounded=1;whiteSpace=wrap;html=1;strokeWidth=2;fillColor=#000000;" vertex="1" parent="XOOXr_gw0LySKT0VeDug-51">
+          <mxGeometry y="31.112000000000002" width="70" height="31.112000000000002" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-54" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;rounded=1;rotation=0;strokeWidth=2;" vertex="1" parent="1">
+          <mxGeometry x="391" y="120" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-55" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;rounded=1;rotation=0;strokeWidth=2;" vertex="1" parent="1">
+          <mxGeometry x="585" y="173" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-57" value="" style="group;aspect=fixed;" vertex="1" connectable="0" parent="1">
+          <mxGeometry x="142.5" y="231.11" width="70" height="77.78" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-58" value="" style="shape=note;whiteSpace=wrap;html=1;backgroundOutline=1;darkOpacity=0.05;rounded=1;size=20;strokeWidth=2;" vertex="1" parent="XOOXr_gw0LySKT0VeDug-57">
+          <mxGeometry x="3.888888888888889" width="62.22222222222222" height="77.78" as="geometry" />
+        </mxCell>
+        <mxCell id="XOOXr_gw0LySKT0VeDug-59" value="&lt;font size=&quot;1&quot; face=&quot;Maven Pro&quot; color=&quot;#ffffff&quot;&gt;&lt;b style=&quot;font-size: 14px;&quot;&gt;Haplotigs assembly&lt;/b&gt;&lt;/font&gt;" style="rounded=1;whiteSpace=wrap;html=1;strokeWidth=2;fillColor=#000000;" vertex="1" parent="XOOXr_gw0LySKT0VeDug-57">
+          <mxGeometry y="31.112000000000002" width="70" height="31.112000000000002" as="geometry" />
+        </mxCell>
+      </root>
+    </mxGraphModel>
+  </diagram>
+</mxfile>
diff --git a/docs/images/v1/genome_statistics.png b/docs/images/v1/genome_statistics.png
diff --git a/docs/images/v1/genomescope_model.drawio b/docs/images/v1/genomescope_model.drawio
@@ -0,0 +1,77 @@
+<mxfile host="app.diagrams.net" modified="2023-11-15T09:51:49.458Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36" etag="3JvNj2J1H7uT-692clGV" version="22.0.8" type="device">
+  <diagram name="Page-1" id="4GNv6cIebouyW5DHGNJP">
+    <mxGraphModel dx="2261" dy="797" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
+      <root>
+        <mxCell id="0" />
+        <mxCell id="1" parent="0" />
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-4" value="" style="endArrow=none;html=1;rounded=1;strokeWidth=2;strokeColor=#24B064;exitX=1;exitY=0.75;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" target="PnGjP-H9tmNRagLO0WRX-30">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="-680" y="200" as="sourcePoint" />
+            <mxPoint x="-140" y="200" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-5" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;rounded=1;rotation=0;strokeWidth=2;" vertex="1" parent="1">
+          <mxGeometry x="-540" y="190" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-16" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;rounded=1;rotation=0;strokeWidth=2;" vertex="1" parent="1">
+          <mxGeometry x="-383" y="189" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-20" value="concatenate reads" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
+          <mxGeometry x="-560" y="150" width="60" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-21" value="FastK FastK" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
+          <mxGeometry x="-401" y="150" width="60" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-27" value="FastK Histex" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
+          <mxGeometry x="-236" y="150" width="60" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-28" value="Genescopefk" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
+          <mxGeometry x="-237" y="240" width="60" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-30" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;rounded=1;rotation=0;strokeWidth=2;" vertex="1" parent="1">
+          <mxGeometry x="-217" y="190" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-31" value="" style="endArrow=none;html=1;rounded=1;strokeWidth=2;strokeColor=#24B064;" edge="1" parent="1" source="PnGjP-H9tmNRagLO0WRX-34">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="-340" y="280" as="sourcePoint" />
+            <mxPoint x="-200" y="280" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-32" value="" style="endArrow=none;html=1;rounded=1;strokeWidth=2;strokeColor=#24B064;" edge="1" parent="1">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="-331" y="280" as="sourcePoint" />
+            <mxPoint x="-371" y="240" as="targetPoint" />
+            <Array as="points">
+              <mxPoint x="-351" y="280" />
+              <mxPoint x="-371" y="260" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-33" value="" style="endArrow=none;html=1;rounded=1;strokeWidth=2;strokeColor=#24B064;" edge="1" parent="1">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="-371.5" y="249" as="sourcePoint" />
+            <mxPoint x="-371.5" y="209" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-35" value="" style="endArrow=none;html=1;rounded=1;strokeWidth=2;strokeColor=#24B064;" edge="1" parent="1" target="PnGjP-H9tmNRagLO0WRX-34">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="-340" y="280" as="sourcePoint" />
+            <mxPoint x="-200" y="280" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-34" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;rounded=1;rotation=0;strokeWidth=2;" vertex="1" parent="1">
+          <mxGeometry x="-216" y="270" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-36" value="" style="group;aspect=fixed;" vertex="1" connectable="0" parent="1">
+          <mxGeometry x="-750" y="160" width="70" height="80" as="geometry" />
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-37" value="" style="shape=note;whiteSpace=wrap;html=1;backgroundOutline=1;darkOpacity=0.05;rounded=1;size=20;strokeWidth=2;" vertex="1" parent="PnGjP-H9tmNRagLO0WRX-36">
+          <mxGeometry x="3.888888888888889" width="62.22222222222222" height="80" as="geometry" />
+        </mxCell>
+        <mxCell id="PnGjP-H9tmNRagLO0WRX-38" value="&lt;font data-font-src=&quot;https://fonts.googleapis.com/css?family=Maven+Pro&quot; face=&quot;Maven Pro&quot; color=&quot;#ffffff&quot;&gt;&lt;b&gt;&lt;font style=&quot;font-size: 20px;&quot;&gt;Fasta&lt;/font&gt;&lt;/b&gt;&lt;/font&gt;" style="rounded=1;whiteSpace=wrap;html=1;strokeWidth=2;fillColor=#000000;" vertex="1" parent="PnGjP-H9tmNRagLO0WRX-36">
+          <mxGeometry y="32" width="70" height="32" as="geometry" />
+        </mxCell>
+      </root>
+    </mxGraphModel>
+  </diagram>
+</mxfile>
diff --git a/docs/images/v1/genomescope_model.png b/docs/images/v1/genomescope_model.png