Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ancestral: update module docstring to include amino acids #1283

Merged
merged 2 commits into from
Aug 18, 2023

Conversation

joverlee521
Copy link
Contributor

Description of proposed changes

Update ancestral's module docstring to include new feature of inferring amino acid sequences.
Added based on my understanding from reviewing #1258.

Please feel free to elaborate or correct any inaccuracies.

Checklist

  • [ ] Add a message in CHANGES.md summarizing the changes in this PR that are end user focused. Keep headers and formatting consistent with the rest of the file.

@joverlee521 joverlee521 requested a review from a team August 16, 2023 17:49
@joverlee521
Copy link
Contributor Author

A potential question that came to mind when I was writing this:

Should we warn users that nucleotide sequences and amino acid sequences are inferred separately? From my understanding, they are never cross checked within augur ancestral so there could potentially be mismatches between the nucleotide and amino acid mutations.

@jameshadfield
Copy link
Member

Should we warn users that nucleotide sequences and amino acid sequences are inferred separately?

Yes - good idea. One nice aspect of having them both in the same command like this is that we can adopt a codon-aware reconstruction in the future. If we end up parsing annotation files within augur ancestral (as part of #1280) then we could easily test out how often the two reconstructions are contradictory.

Copy link
Contributor

@huddlej huddlej left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for catching this omission from the original PR, @joverlee521! This looks good to me as it is, but would you think to add the warning you mention in the comments to this section?

@joverlee521 joverlee521 merged commit 29bb674 into master Aug 18, 2023
26 checks passed
@joverlee521 joverlee521 deleted the ancestral-docs-update branch August 18, 2023 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

3 participants