Skip to content

Commit 3d98251

Browse files
committed
add mash_dist documentation
1 parent 3cb86fb commit 3d98251

File tree

5 files changed

+33
-0
lines changed

5 files changed

+33
-0
lines changed
138 KB
Loading
65.1 KB
Loading

docs/user/pipeline_reports.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Pipeline reports
99
.. include:: reports/fastqc.rst
1010
.. include:: reports/fastqc_trimmomatic.rst
1111
.. include:: reports/integrity_coverage.rst
12+
.. include:: reports/mash_dist.rst
1213
.. include:: reports/mlst.rst
1314
.. include:: reports/patho_typing.rst
1415
.. include:: reports/pilon.rst
@@ -18,6 +19,7 @@ Pipeline reports
1819
.. include:: reports/process_spades.rst
1920
.. include:: reports/process_viral_assembly.rst
2021
.. include:: reports/seq_typing.rst
22+
.. include:: reports/sistr.rst
2123
.. include:: reports/trimmomatic.rst
2224
.. include:: reports/true_coverage.rst
2325

docs/user/reports/mash_dist.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
mash_dist
2+
---------
3+
4+
Table data
5+
^^^^^^^^^^
6+
7+
Plasmids table:
8+
- **Mash Dist**: Number of plasmid hits
9+
10+
.. image:: ../resources/reports/mash_dist_table.png
11+
:align: center
12+
13+
Plot data
14+
^^^^^^^^^
15+
16+
- **Sliding window Plasmid annotation**: Provides annotation of plasmid
17+
hits along the genome assembly. This report component is only available
18+
when the ``mash_dist`` component is used.
19+
20+
.. image:: ../resources/reports/sliding_window_mash_dist.png

docs/user/reports/sistr.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
sistr
2+
-----
3+
4+
Table data
5+
^^^^^^^^^^
6+
7+
Typing table:
8+
- **sistr**: The sequence typing result.
9+
10+
.. image:: ../resources/reports/typing_table.png
11+
:align: center

0 commit comments

Comments
 (0)