|
4 | 4 |
|
5 | 5 | --- |
6 | 6 |
|
7 | | -**_Note_** Phyx recently overwent an overhaul such that a simple `git pull && git make` will fail. Instead, see instructions [here](#problems-after-updating-git-pull). |
| 7 | +**_Notes_** |
| 8 | + |
| 9 | +1. Phyx recently overwent an overhaul such that a simple `git pull && git make` will fail. Instead, see instructions [here](#problems-after-updating-git-pull). |
| 10 | +2. If you are experiencing crashing or truncated results, please consider the illegal input characters described [here](#illegal-characters). |
8 | 11 |
|
9 | 12 | --- |
10 | 13 |
|
@@ -88,6 +91,25 @@ If you have been using phyx and things are not working after a recent pull, this |
88 | 91 | make check |
89 | 92 | sudo make install |
90 | 93 |
|
| 94 | +## Illegal characters |
| 95 | +While we can make no claim that `phyx` is free of bugs :P, the vast majority of program crashes have been tracked back to problematic data. These fall into two categories. |
| 96 | + |
| 97 | +First, and most simply, `phyx` expects unix line-endings. If your input files originated, at at some point were processed, on Windows, then it is possible that Windows line-endings are present, and may impede results, especially when piping. Fortunately switching to unix line-endings is very easy. If you are on linux you can install `dos2unix` with the command: |
| 98 | + |
| 99 | + sudo apt-get install dos2unix |
| 100 | + |
| 101 | +and then convert your file thusly: |
| 102 | + |
| 103 | + dos2unix FILE |
| 104 | + |
| 105 | +Second, and more insidiously, if any programs involving trees crash outright or give truncated results, the first thing to consider is whether the taxon names contain characters that are deemed illegal by Nexus ("()[]{}/\,;:=*'"`+-<>";) or newick("()[]':;,") formats. These are prolematic because they seemingly indicate a comment, or the termination of a tree, etc. The way to correct this issue is to either: |
| 106 | + |
| 107 | +1. Remove these offending characters from the file (which may make things difficult when running analyses elswhere with other files that have not been processed in this way), or |
| 108 | + |
| 109 | +2. Put quotes around the troublesome names, as this is the expected way to incorporate such characters. |
| 110 | + |
| 111 | +An [issue](https://github.com/FePhyFoFum/phyx/issues/138) has been made where discussion of this, er, issue, can be had. |
| 112 | + |
91 | 113 | # Installation instructions |
92 | 114 | phyx requires a few dependencies. Since installation of these dependencies differs on [Linux](#linux-install) vs. [Mac OSX](#mac-install), we've separated the instructions below. |
93 | 115 |
|
|
0 commit comments