TNT_Script/README.md

134 lines
3.3 KiB
Markdown
Raw Normal View History

2023-02-26 02:42:56 +08:00
# TNT Script used by Guoyi
2023-09-14 00:16:32 +08:00
The TNT script follows MIT license.
2023-02-26 02:42:56 +08:00
2023-02-26 03:32:18 +08:00
## Usage
2023-02-26 02:42:56 +08:00
2023-02-27 01:42:50 +08:00
- Place this script and your matrix tnt file `filename` under the folder that you call `tnt` or `exe` file is placed
2023-02-26 03:45:29 +08:00
2023-02-27 01:24:22 +08:00
- Enter `tnt`
2023-02-26 03:32:18 +08:00
2023-02-27 01:24:22 +08:00
- Enter command `guoyi filename;`
2023-02-26 03:32:18 +08:00
2023-02-27 01:24:22 +08:00
## Functions
2023-02-26 03:32:18 +08:00
2023-09-14 00:16:32 +08:00
- Extended implied weighting with K value setting (default, default K=12) or implied weighting with K value setting (default K=12) or equal weighting.
2023-02-26 03:45:29 +08:00
2023-09-14 00:16:32 +08:00
- Search trees via implicit enumeration (ntax<=25, but not for eiw) or TBR Mult (1000 times) with branch swapping (25<ntax<75, also for ntax<=25 with eiw) or Mult with branch swapping and Xmult (use random sectorial searches, produce 1,000 hits to best length and stop, 10 cycles of drifting, ratchet and fusing) (ntax>=75).
2023-02-26 03:45:29 +08:00
2023-09-13 21:05:52 +08:00
- Perform Strict consensus / Majority-rule consensus / Half strict consensus.
2023-02-27 01:24:22 +08:00
2023-09-14 00:08:43 +08:00
- Calculate jackknifing (1,000 times), bootstrap (1,000 times) and Relative Bremer support.
2023-02-27 01:24:22 +08:00
- Map apomorphic characters on the consensus tree.
2023-02-27 01:24:22 +08:00
- Calculate TL, CI, and RI.
2023-02-26 03:45:29 +08:00
2023-02-26 03:32:18 +08:00
## Options
2023-02-26 02:42:56 +08:00
2023-09-13 21:05:52 +08:00
For Windows users
```
2023-09-14 00:08:43 +08:00
tnt run guoyi.run filename datatype weight 0/K cons resample prefix;
2023-09-13 21:05:52 +08:00
```
For Linux and Mac users
```
2023-09-14 00:08:43 +08:00
tnt run guoyi.run filename datatype weight K cons resample prefix,
2023-09-13 21:05:52 +08:00
```
- datatpye should be `32`, `dna`, `prot`, `num`
- num=number, dna=DNA, prot=protein, 32=max number allowed (default)
2023-09-14 00:10:08 +08:00
- weight should be `iw`, `ew`, `eiw`
2023-09-13 21:05:52 +08:00
- iw=implied weight, ew=equal weight, eiw=extended implied weight (default) N.B. ew must followed 0 (the K value position for ew iw and eiw)
2023-09-14 00:10:08 +08:00
- K is `12` (default) following Goloboff et al. 2017 (Cladistics 34: 407437)
2023-09-14 00:08:43 +08:00
- it must more than 0
2023-09-14 00:10:08 +08:00
- cons should be `str`, `mjr`, `hlf`
2023-09-13 21:05:52 +08:00
- mjr=majority rule, hlf=half, str=strict (default)
- resample should be sum of what you want
- jak=1, boot=2, relative bremer=4 i.e. jak+boot+bremer=7 (default)
2023-09-14 00:08:43 +08:00
- prefix can be empty or a string
- default is empty
2023-09-13 21:05:52 +08:00
## Results
2023-02-27 01:24:22 +08:00
- Results instructions are at the end of `tnt.log`.
- `trees.tre`, `resample.tre` are trees with taxname.
2023-02-27 01:37:48 +08:00
- `trees_no.tre`, `resample_no.tre` are trees without taxname.
2023-02-26 02:42:56 +08:00
- `winclada.tre` can be transferred to the acceptable format for WinClada by tnt2winclada and the output file can be put into Winclada with your tnt matrix file `filename` for mapping apomorphic characters and homoplasy.
2023-07-17 06:31:26 +08:00
## Cite
Cite this script is mandatory, list me (Guoyi Zhang) in your Acknowledgements is recommended.
# TNT2WinClada
```
~|~|\ |~|~ ~) | |o._ |~| _ _| _
| | \| | /_ \/\/ || ||_|(_|(_|(_|
MIT, Guoyi Zhang, 2023
```
## Function
Convert TNT output tree file without tags and taxname, e.g. `winclada.tre` produced by TNT script, to WinClada acceptable format tree.
## Compile
### Linux & Unix
```
2023-07-18 16:42:35 +08:00
mkdir -p build && cd build
cmake ..
make && make install
```
### Windows
```
cl /EHsc tnt2winclada.cpp
```
## Usage
```
tnt2winclada -i ${input_file} -o ${output_file}
```
2023-07-17 06:31:26 +08:00
Interactive commands are also available.
2023-07-18 16:42:35 +08:00
```
tnt2winclada
~|~|\ |~|~ ~) | |o._ |~| _ _| _
| | \| | /_ \/\/ || ||_|(_|(_|(_|
TNT2WinClada
MIT, Guoyi Zhang, 2023
please type help to see more commands
tnt2winclada> help
help show interactive commands help
input <filename> input a TNT output tree from the specified file
output <filename> output a winclada accessible tree file
quit quit the program
exit exit the program
tnt2winclada>
```