Skip to content

Commit

Permalink
updated docs for rename fasta entries and RCVT to include cpu multipr…
Browse files Browse the repository at this point in the history
…ocessing support
  • Loading branch information
JLSteenwyk committed Sep 18, 2024
1 parent a4a2e91 commit e441d34
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/usage/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -569,10 +569,11 @@ a lower composition bias for a given taxon in an alignment.

.. code-block:: shell
phykit relative_composition_variability_taxon <alignment>
phykit relative_composition_variability_taxon <alignment> [--cpu <cpu>]
Options: |br|
*<alignment>*: first argument after function name should be an alignment file
*<alignment>*: first argument after function name should be an alignment file |br|
*\\-\\-cpu*: CPUs to use to accelerate calculation

|
Expand All @@ -591,11 +592,12 @@ an alignment file.

.. code-block:: shell
phykit rename_fasta_entries <fasta> -i/--idmap <idmap> [-o/--output <output_file>]
phykit rename_fasta_entries <fasta> -i/--idmap <idmap> [-o/--output <output_file> --cpu <cpu>]
Options: |br|
*<alignment>*: first argument after function name should be an alignment file |br|
*-i/\\-\\-idmap*: identifier map of current FASTA names (col1) and desired FASTA names (col2)
*-i/\\-\\-idmap*: identifier map of current FASTA names (col1) and desired FASTA names (col2) |br|
*\\-\\-cpu*: CPUs to use to accelerate calculation

|
Expand Down

0 comments on commit e441d34

Please sign in to comment.