diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 904959c..cf404db 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -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. diff --git a/docs/usage.rst b/docs/usage.rst index 326f4a2..de42d84 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -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::