Skip to content

Commit 8eecc28

Browse files
authored
updated readme
1 parent 5bd9203 commit 8eecc28

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ Two example files are provided:
7373
```
7474
(((a,(b,(c,d))),f),e);
7575
(((a,(b,(e,d))),c),g);
76+
((a,(b,(e,d))),c);
7677
```
7778
These trees can be rooted or unrooted. `clan_check` will unroot all rooted trees before carrying out the analysis.
7879

@@ -93,14 +94,23 @@ The output will be named `[phylip formatted tree file].scores.txt` and will have
9394

9495
|Tree number | size | Clan 1 | Clan 2 | Clan 3 | Clan 4 | Clan 5 | Clan 6 |
9596
|------------|------|--------|--------|--------|--------|--------|--------|
96-
|Tree 1 | 6 | 1 | 1 | 0 | 1 | 1 | 1 |
97+
|Tree 1 | 6 | 1 | 1 | 0 | 1 | 1 | ? |
9798
|Tree 2 | 6 | 0 | 1 | 0 | 1 | 1 | 1 |
99+
|Tree 3 | 5 | 0 | 1 | 0 | 1 | 1 | ? |
98100

99101
Where `tree number` is in the same order as the input trees, `size` = the number of taxa in the tree, `Clan x` is the clan definied by the xth line of the clan file.
100102

101-
In this example Clan 3 defined as having the monophyly of "c d a" was violated in both tree 1 and tree 2.
103+
A "1" in the table means that this tree did not violate this clan.
104+
A "0" in the table means that this tree violated this clan.
105+
A "?" in the table means that there were not enough taxa from the Clan in this tree to carry out the test (minimum required is 2 taxa).
106+
107+
All three trees did not contain Clan 3, (c d a) despite all three trees containing all three taxa
108+
109+
Both tree 2 and tree 3 did not contain clan 1 (c d b), despite both trees containing all three taxa
110+
111+
We could not test Clan 6 (g d) against Tree 1 or Tree 3 as neither of those trees had taxon "g".
112+
102113

103-
Overall, Tree 2 violated 2 of the clans and tree 1 violoated 1.
104114

105115
## Caveats
106116

0 commit comments

Comments
 (0)