Skip to content

A python parser for jplace (evolutionary placement) files

License

Notifications You must be signed in to change notification settings

Robaina/Jplaceparser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

logo

a Python tool to parse and manipulate JPlace files, the format of Evolutionary Placement results.

PyPI GitHub release (latest by date) GitHub license Contributor Covenant DOI


What is JPLACEparser?

JplaceParser allows not only reading Jplace files as python dictionaries but also manipulating field values and exporting back to jplace files. It contains a number of filters to remove placements that do not satisfy quality criteria. Currently, placements can be filtered by three criteria involving the pendant and distal placement length as well as the phylogenetic tree diameter:

  • Filter by maximum pendant length
  • Filter by maximum pendant to distal length ratio
  • Filter by maximum pendant to tree diameter ratio
  • Filter my minimum LWR

This is an ongoing project!

Installation

  1. pip install jplaceparser

or

  1. Git clone project to local directory.

    In terminal navigate to directory and enter: python setup.py install

Usage

You can find a jupyter notebook with usage examples here.

Citation

If you use this software, please cite it as below:

Robaina-Estévez, S. (2022). JPLACEparser: a Python tool to parse and manipulate JPlace files (Version 0.0.1)[Computer software]. https://doi.org/10.5281/zenodo.7031582.