Code Monkey home page Code Monkey logo

phyloconverge's Introduction

phyloconverge

DESCRIPTION

phyloconverge has not been tested extensively and is being actively developed. Please use with caution. I appreciate hearing about your experience with the program.

phyloconverge is an algorithm to look for convergence based on a particular trait in a phylogenetic tree. The traits can be quantitative (e.g., size in centimeters or depth of observation) or can be categorical (e.g., associated with hydrothermal vents or not associated with hydrothermal vents).

=======

ALGORITHM

Essentially, the algorithm splits a tree (supplied in --treefile) in half (or as close to as half as possible) and compares the sum of attributes (supplied in --tabfile) of the clade with the highest sum of attributes to the maximum sum of attributes possible given the size of the clade and the taxa in the tree.

The priority for scoring is based on the evenness of the split, not the clade that encompasses the highest score for the trait.

AVAILABILITY

https://github.com/josephryan/phyloconverge (click the "Download ZIP" button at the bottom of the right column).

DEPENDENCIES

NOTE: python is called within perl to process the treefile

General system tools:

Additional libraries

INSTALLATION

To install phyloconverge and documentation, type the following:

perl Makefile.PL
make
make test
sudo make install

To install dendropy, depending on your system, you can probably use this command:

sudo pip install dendropy

RUN

phyloconverge --treefile=NEWICKTREEFILE --tabfile=TABFILE_W_ATTRIBUTES

EXAMPLE ANALYSES

phyloconverge --treefile=examples/converged.tre \
              --tabfile=examples/depths.txt

phyloconverge --treefile=examples/notconverged.tre \
              --tabfile=examples/depths.txt
              
converge_tree.py -t examples/notconverged.tre -d examples/depths.txt

To generate a table of results from many trees with one data file:

for T in Treefiles_*; do converge_tree.py -d datatable.txt -t "$T" >> AllResults.txt; done; 

DOCUMENTATION

VERY Extensive documentation is embedded inside of phyloconverge in POD format and can be viewed by running any of the following:

    phyloconverge --help
    perldoc phyloconverge
    man phyloconverge  # available after installation

COPYRIGHT AND LICENSE

Copyright (C) 2013 Joseph F. Ryan

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program in the file LICENSE. If not, see http://www.gnu.org/licenses/.

phyloconverge's People

Contributors

josephryan avatar beroe avatar

Watchers

James Cloos avatar Miao Sun avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.