Skip to content

Commit

Permalink
Update docs to mention new argument for annotate_hits_pyseer
Browse files Browse the repository at this point in the history
Finishes #253
  • Loading branch information
mgalardini committed Nov 9, 2023
1 parent 6e1a79e commit b5b7564
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,10 @@ haven't already been mapped to a previous annotation (requires ``bedtools``, ``b
.. note:: If this runs slowly you can split the ``significant_kmers.txt`` file into
pieces to parallelise the process.

.. note:: By default ``annotate_hits_pyseer`` will only consider CDS features in the
provided GFF files. If you want to consider other feature types you can use the
``--feature-type`` option (*e.g.* ``--feature-type rRNA --feature-type tRNA``).

Annotations marked ``ref`` can partially match between k-mer and reference
sequence, whereas those marked ``draft`` require an exact match. In this case
the single draft didn't add any matches.
Expand Down
4 changes: 4 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -660,6 +660,10 @@ ID will be used.
of each query is slow, so only significant k-mers should be annotated in
this manner.

.. note:: By default ``annotate_hits_pyseer`` will only consider CDS features in the
provided GFF files. If you want to consider other feature types you can use the
``--feature-type`` option (*e.g.* ``--feature-type rRNA --feature-type tRNA``).

To summarise these annotations over all significant k-mers, use the
``summarise_annotations.py`` script::

Expand Down

0 comments on commit b5b7564

Please sign in to comment.