Skip to main content

Computes measures of (dis)similarity between phylogenetic trees. Provides summaries of shared and unique bipartitions.

Project description

treedist: command line program for quantifying differences between phylogenetic trees

The command-line program treedist takes as input two or more treefiles and computes various measures of the "distance" between pairs of trees. The program can also output information about how many and what bipartitions differ between trees.

Availability

The treedist source code is available on GitHub: https://github.com/agormp/treedist. The executable can be installed from PyPI: https://pypi.org/project/treedist/

Installation

python3 -m pip install treedist

Dependencies

treedist relies on the phylotreelib library, which is automatically included when using pip to install.

Overview

  • Input:
    • Two or more files containing phylogenetic trees (all trees must have same leaf names), in NEXUS or Newick format.
  • Output:
    • Different measures of treesimilarity (Robinson-Fould's symmetric distance, normalised RF, normalised similarity)
    • Summaries of what bipartitions that differ or are shared between trees

Usage

Usage: treedist [options] TREEFILE1 TREEFILE2 [TREEFILE3 ...]

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -I FORM, --informat=FORM
                        format of tree files: NEXUS or newick [default:
                        newick]
  -d, --symnormdist     print normalized symmetric distance
  -s, --symdist         print symmetric distance
  -b, --bipnumbers      print no. total, shared, and unique bipartitions for
                        each tree
  -u, --uniquelist      print list of unique bipartitions for each tree
  -c, --commonlist      print list of bipartitions trees have in common
  -l, --labels          also print branch labels for bipartitions (requires -c
                        or -u)
  -o, --oneline         oneline output of normalized symmetric similarities
  -n, --namesummary     Print names of leaves that are shared between trees,
                        and leaves that are discarded
  --collapselen=BRLEN[,BRLEN,...]
                        Collapse branches shorter than this (comma-separated
                        list: individual cutoffs for trees)
  --collapsefrac=FRAC   Collapse branches shorter than FRAC fraction of
                        treeheight (of minimum variance rooted tree)
  --collapsesupport=SUPPORT
                        Collapse branches with less clade support than this
                        (must be number in [0,1])

Usage examples

TBD

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

treedist-1.0.0.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

treedist-1.0.0-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

Details for the file treedist-1.0.0.tar.gz.

File metadata

  • Download URL: treedist-1.0.0.tar.gz
  • Upload date:
  • Size: 18.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for treedist-1.0.0.tar.gz
Algorithm Hash digest
SHA256 b02fdee0a68bee33a91d9fc75f57750b31e06789a3738ef3964ab8c7f1508bb4
MD5 5145e172d91cb0ff86c22f9eddc15b78
BLAKE2b-256 4c8705026b03fec349e9408b605b7e5903e21585b3001140c88601fba43cb8dd

See more details on using hashes here.

File details

Details for the file treedist-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: treedist-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 18.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for treedist-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c81a697e26972b3360ac93a1e1b73c76ee59b617f992c8b70e085bb3586e0c9f
MD5 d4220602f04c1c3b9417cd9d9b5f3c2b
BLAKE2b-256 fdcb8dafa530a3a599fd678a0e74df2146154e4655b4221203302d81305a66aa

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page