Skip to main content

Tool for the estimation of the difficulty of phylogenetic placements

Project description

BAD: Bold Assertor of Difficulty

image image image

Description

BAD is a python tool for predicting the difficulty of phylogenetic placements. BAD uses RAxML-NG outputs as input. It requires a RAxML-NG installation. It was trained on empirical datasets from TreeBASE and can use both AA and DNA data. The output of BAD is a score between 0 (easy) and 1 (difficult). BAD provides an explanation of its prediction using the Shapley values implementation SHAP (Github, Paper).

Installation

Using pip

pip install bad-phylo

Usage Example

A simple command line call of BAD looks like this:

bad -msa /test/example.fasta -tree /test/example.bestTree -model /test/example.bestModel -query /test/query.fasta -o test_bad 

This command will use the MSA and query file in fasta format, and the best tree inferred with RAxML-NG as well as the model. It will compute features from all four data sources and predict the placement difficulties for each taxon in the query file. All output files will be stored in an output folder called test_bad in the current directory. BAD will summarize the explanations for the prediction in the command line. For further details, please look at the SHAP summary plots or the bad.log file in the output folder.

Before interpreting the explanations provided by BAD, please make sure you know how to properly interpret Shapley values. Easy to understand introduction to Shapley values: https://christophm.github.io/interpretable-ml-book/shapley.html

Please keep in mind that BAD requires an installation of RAxML-NG. By default, it uses the command raxml-ng. If your RAxML-NG installation is not part of the PATH variable, you can specify the path to the RAxML-NG binary file with the parameter -raxmlng PATH_TO_RAXMLNG.

References

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

bad-phylo-0.0.2.tar.gz (117.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bad_phylo-0.0.2-py3-none-any.whl (120.7 kB view details)

Uploaded Python 3

File details

Details for the file bad-phylo-0.0.2.tar.gz.

File metadata

  • Download URL: bad-phylo-0.0.2.tar.gz
  • Upload date:
  • Size: 117.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for bad-phylo-0.0.2.tar.gz
Algorithm Hash digest
SHA256 4b03bcdb4c62c547549455a3a3f15bb1c289b54a986d5fcf80964853713cf614
MD5 133aef1c12014f205f21117a4e0e2cf2
BLAKE2b-256 be8cce567f6e37458111037e34ce953dccae59875dd7161d0e935e3dc482d1a2

See more details on using hashes here.

File details

Details for the file bad_phylo-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: bad_phylo-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 120.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for bad_phylo-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 66c998db2628bce86f822ab8807f131f547cb5bb74349f9bfcb1e9e9de478c87
MD5 fb41e3819863d0d00288e0e36fab5dc6
BLAKE2b-256 b70bf3eb9aa7ce8a8ed72c4cd2148282bb063d595568c11f0cb63b4f7aee6b16

See more details on using hashes here.

Supported by

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