Skip to content

Commit

Permalink
Describe use of partial query graphs
Browse files Browse the repository at this point in the history
  • Loading branch information
nickjcroucher committed Oct 11, 2024
1 parent 79dd044 commit 396b3c2
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/visualisation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ At least one of these output types must be specified as a flag.
If you are running multiple visualisations this calculation will be completed every time. To avoid
this re-run your assignment with ``--update-db``, which will add these distances in permanently.

If you are only interested in visualising sequences that are closely-related to those in a set of
query sequences, then the quickest approach is to use the ``--save-partial-query-graph`` option
when assigning sequences. This will generate a list of sequences spanning both your queries, and all
the reference database isolates that are in the same network components (i.e., excluding those that
are not related to your query isolates); this is contained in the file ``[prefix]_query.subset``. This list
can be passed to the visualisation command using the flag ``--use-partial-query-graph ./[prefix]/[prefix]_query.subset``
to only visualise the parts of the network that are relevant to your query.

Common options
--------------
Some typical commands for various input settings (with ``--microreact``, but this can
Expand Down

0 comments on commit 396b3c2

Please sign in to comment.