Metadata-Version: 2.1
Name: pear-ebi
Version: 0.1.1.7
Summary: Embeds phylogenetic tree distances and produce representations
Home-page: https://github.com/AndreaRubbi/TreeEmbedding
Author: Andrea Rubbi
Author-email: andrea.rubbi.98@gmail.com
License: MIT License
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# TreeEmbedding <img href="https://github.com/AndreaRubbi/TreeEmbedding/raw/main/goldman_logo.jpg" width="50" height="50">
### by Goldman group - EMBL-EBI

TreeEmbedding can:
1. Compute the distance matrix given a set of phylogenetic trees;
2. Embed and represent the distance matrix in 2D or 3D.

## TreeEmbedding usage
Please, run `python3 ./main.py --help` to see the complete list of required arguments and flags.

### Simple usage
`python3 ./main.py examples_trees_sets/beast_trees_500_tips.txt --hashrf --pca 3`
this script calculates the distances between the trees in the file "beast_trees_500_tips.txt", which contains 2001 phylogenetic trees. 
The flag "--hashrf" defines the use of HasRF algorithm to perform this task [See HashRF documentation](https://code.google.com/archive/p/hashrf/).
The flag "--pca 3" indicates to the program to perform a Principal Coordinate Analysis to embed the distance matrix in 3 dimensions, returning the final coordinates in the lower-dimensional space and plotting them in 2D and 3D.

### Interactive mode
`python3 ./main.py examples_trees_sets/beast_trees_500_tips.txt --i`
this script launches the program in interactive mode. Once the program starts, it is going to guide you through its usage thanks to an intuitive interface.
