Skip to content

Commit 95b4525

Browse files
committed
updated docs for mash components
1 parent b4a3f7a commit 95b4525

File tree

4 files changed

+14
-6
lines changed

4 files changed

+14
-6
lines changed

docs/user/components/mash_dist.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,10 @@ Parameters
4444

4545
- ``refFile``: Specifies the reference file to be provided to mash. It can either
4646
be a fasta or a .msh reference sketch generated by mash.
47-
Default: '/ngstools/data/patlas.msh'.
47+
Default: '/ngstools/data/patlas.msh'. If the component ``mash_sketch_fasta``
48+
is executed before this component, this parameter will be ignored and instead
49+
the secondary link between the two processes will be used to feed this
50+
component with the reference sketch.
4851

4952

5053
Published results

docs/user/components/mash_screen.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,11 @@ Parameters
3838
reference sequence. Default: 0.9.
3939

4040
- ``refFile``: "Specifies the reference file to be provided to mash. It can
41-
either be a fasta or a .msh reference sketch generated by mash.
42-
Default: '/ngstools/data/patlas.msh'.
41+
either be a fastq or a .msh reference sketch generated by mash.
42+
Default: '/ngstools/data/patlas.msh'. If the component ``mash_sketch_fastq``
43+
is executed before this component, this parameter will be ignored and instead
44+
the secondary link between the two processes will be used to feed this
45+
component with the reference sketch.
4346

4447

4548
Published results

docs/user/components/mash_sketch_fasta.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ Default directives
4444

4545
- ``mashSketchFasta``:
4646
- ``container``: flowcraft/mash-patlas
47-
- ``version``: 1.4.1
47+
- ``version``: 1.6.0-1

docs/user/components/mash_sketch_fastq.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ mash_sketch_fastq
44
Purpose
55
-------
66

7-
This component performs mash sketch for fastq input files.
7+
This component performs mash sketch for fastq input files. These sketches can
8+
be used by ``mash_dist`` and ``mash_screen`` components to fetch the
9+
reference file for mash.
810

911
.. note::
1012
- MASH documentation can be found `here <https://mash.readthedocs.io/en/latest/>`_.
@@ -52,4 +54,4 @@ Default directives
5254

5355
- ``mashSketchFastq``:
5456
- ``container``: flowcraft/mash-patlas
55-
- ``version``: 1.4.1
57+
- ``version``: 1.6.0-1

0 commit comments

Comments
 (0)