myte

myte-tests Build Status Crates-Io GH-Release

A tool for phylogenomic tree building. The program estimates species tree, gene trees, gene concordance factor, site concordance factor, and organize resulting files using a single command:

{Bash} myte auto -d [gene-alignment-folder]

Similar functions can be achieved using a Bash script running GNU parallel. Our solution, however, carries some benefits:

  1. No coding skills needed. The app is a single executable command line app. The way it is designed omits the need to change the code.
  2. Allow for reproducibility. All changes in the app are tracked using git workflow. It also generate a log file when running.
  3. Flexible. The app lets users to specify the analysis parameters. The app design allows current and future parameters available in the IQ-TREE and Astral.
  4. Low overhead. It is written in a high-performance programming language with low ram and cpu usages.
  5. Safe parallel processing. It takes the advantages of the Rust programming language parallel computing algorithms that avoid data races.

Limitation:

The app does not yet support MPI. It is designed to run in a desktop computer and take advantage of all the available cores in it when possible. It should work in a cluster computer just fine, but will be limited to a single CPU in a single node.

Installation

myte is a single executable command line app. The executable file will be available in the release link. Copy it to the folder that is registered in your PATH variable.

You can also install the app using the Rust package manager cargo:

Bash cargo install myte

OS support:

  1. MacOS
  2. Linux
  3. Windows-WSL

Note: We provide Apple Arm64 executable for MacOS. myte will run native on Apple Arm64 CPUs (M1 series). However, due to IQ-TREE suported CPU architecture limitation, IQ-TREE will run on the Apple Rosetta emulator.

Dependencies:

  1. IQ-TREE2
  2. Astral (optional)

To check if the app can detect the dependencies:

Bash myte check

See segul readme for details instruction on how to install a command line application written in Rust.

Compile from source

Download the rust compiler here and follow the installation instruction.

{Bash} git clone https://github.com/hhandika/myte

```{Bash} cd myte

cargo build --release ```

Your executable will be available at /target/release/myte. Copy it to the folder that is registered in your PATH variable.

Fixing dependencies

The program detects iqtree2 installation from the environment path variable. If the program fails to detect IQ-TREE, make sure the executable is called iqtree2 (no spaces) and the directory where you put the IQ-TREE executable is registered to your environment path variable.

For Astral installation, the app can help solve the Astral dependency. Go to the folder where you install Astral. Then, use this command to solve the dependency:

Bash myte deps astral -j [path-to-astral-jar-file]

It will generate an executable file named astral.sh. Put the astral.sh file in a directory that is regiestered in your environment variable.

Try to check the dependencies again:

Bash myte check

Usages

```{Bash} USAGE: myte

FLAGS: -h, --help Prints help information -V, --version Prints version information

SUBCOMMANDS: auto Auto estimate species tree, gene trees, and gene and site concordance factor check Check dependencies deps Solves dependency issues gene Multi-core gene tree estimation using IQ-Tree help Prints this message or the help of the given subcommand(s) ```

Auto estimate species, gene trees and gene and site concordance factors

This feature is particularly useful for running the analyses using a desktop computer. If you have access to a cluster computer, you could separately run species tree analyses, gene and site concordance factors, and Astral MSC phylogenetic estimation. Only use this program to run gene tree analyes in parallel (see below).

{Bash} myte auto -d [alignment-folder]

For species tree estimation, the default option will run IQ-TREE using this command:

Bash iqtree2 -s ../genes/ --prefix concat -T 1 -B 1000

For gene tree estimation, the default option will run IQ-TREE using this command:

Bash iqtree2 -s [alignment-path] --prefix [gene-names] -T 1

The app allow any current and future available parameters on IQ-TREE for species tree and gene tree estimation.

You can specify IQ-TREE parameters for the species tree using option --opts-s=.

For example

Bash myte auto -d genes/ opts-s="-T 4 -bnni -B 1000"

Similar to species tree estimation, you can specify any IQ-TREE parameters using the --opts-g= option in the app.

By default the app looks for nexus files in your alignment directory. To specify the file format, use the --input-fmt option or the short option -f. Other than nexus format, the app supports fasta and phylip. Use the help command to see all the options:

Bash myte auto --help

Estimate gene trees from a directory of gene alignments

The program will create multiple instances of IQ-TREE to run gene tree estimation in parallel. The program assess available cpu resources in your system and does it sensibly.

To generate gene trees:

{Bash} myte gene -d [alignment-folder]

You can also specify IQ-TREE parameters using --opts-g= option. Similar to the auto format, by default, the app will look for nexus files. Use the same option as the auto sub-command to specify the input format.

Contribution

We welcome any kind of contribution, from issue reporting, ideas to improve the app, to code contribution. For ideas and issue reporting please post in the Github issues page. For code contribution, please fork the repository and send pull requests to this repo.