etetoolkit / ete

Python package for building, comparing, annotating, manipulating and visualising trees. It provides a comprehensive API and a collection of command line tools, including utilities to work with the NCBI taxonomy tree.
http://etetoolkit.org
GNU General Public License v3.0
795 stars 214 forks source link

ete evol: Incorrect documentation for the b_free - b_neut test #748

Open lab83bio opened 6 months ago

lab83bio commented 6 months ago

Hi, The ete3 evol documentation is well presented and easy to read. However, I think there are several typos in the explanation of the b_free - b_neut test (ex. here and here):

Alternative Null Test
b_free b_neut foreground branch not neutral (w != 1)
- RX if P<0.05 (means that w on frg=1)
- PS if P>0.05 and wfrg>1
- CN if P>0.05 and wfrg>1
(Ziheng Yang (2002))
I think this should read: Alternative Null Test
b_free b_neut foreground branch not neutral (w != 1)
- RX if P>0.05 (means that w on frg=1)
- PS if P<0.05 and wfrg>1
- CN if P<0.05 and wfrg<1
(Ziheng Yang (2002))

Also CN (CoNserved?) is not defined. Maybe NS (Negative Selection) would be more intuitive.