Skip to content

Commit

Permalink
Merge pull request #1283 from nextstrain/ancestral-docs-update
Browse files Browse the repository at this point in the history
ancestral: update module docstring to include amino acids
  • Loading branch information
joverlee521 committed Aug 18, 2023
2 parents 7c6b823 + cc9ca1c commit 29bb674
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions augur/ancestral.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@
that has a mismatch between its own sequence and its parent's sequence.
The node sequences and mutations are output to a node-data JSON file.
If amino acid options are provided, the ancestral amino acid sequences for each
requested gene are inferred with the same method as the nucleotide sequences described above.
The inferred amino acid mutations will be included in the output node-data JSON
file, with the format equivalent to the output of `augur translate`.
The nucleotide and amino acid sequences are inferred separately in this command,
which can potentially result in mismatches between the nucleotide and amino
acid mutations. If you want amino acid mutations based on the inferred
nucleotide sequences, please use `augur translate`.
.. note::
The mutation positions in the node-data JSON are one-based.
Expand Down

0 comments on commit 29bb674

Please sign in to comment.