Update codon models and frequencies documentation #18
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation about codon model from a close reading of https://github.com/iqtree/iqtree3/blob/master/model/modelcodon.cpp.
The main change is a detailed note on how the mechanistic models compute rates. This is required because
MGdoes not actually implement what MG1994 does, specifically deviating in how multi-nt changes are handled: the original paper sets a rate of 0 while iqtree does something else.I also added a mention of
GY0K. It does not have a literature reference but is in the code. Describing it first makes describing all the GY-with-kappa models easier.Other small changes are:
ECMalias forECMK07because it is in the code.MGandGY0Kin the "substitution rates" section by pointing to the frequency section. Adding a pointer here helps answer questions like "what's the difference between MG2K and GY2K?"