Skip to main content

A tool to analyse Hierarchical Orthologous Groups (HOGs)

Project description

Motivation

pyHam is a library to facilitate the analysis of hierarchical orthologous groups. It also contains a few tools to run standard type of analysis.

Currently, Ham is limited to analyze HOGs that are stored in an orthoXML file. More information on the schema of orthoxml and some examples are available at http://orthoxml.org.

For extended documentation we refer to the docs folder that contain information on common use cases and API documentation of the library.

Installation

Ham is written in python3 (also compatible with python2), with little external dependencies, i.e. currently ete3, lml, six. The setup script should resolve these dependencies automatically. Consider using pip to install the package directly from a checked out git repo

python -m pip install --upgrade pip
pip install pyham

Example

We prepare a ready-to-use example (see example folder) with few python scripts to use main pyHam features. You just have to run the following command in bash:

python run_hog_queries.py
python run_treeProfile.py
python run_iHam.py

Getting started

We create a small introductory blog post about HOGs and pyHam at http://lab.dessimoz.org/blog/2017/06/29/pyham. We highly recommend you to read it before starting using pyHam.

We also create an ipython notebook to help you with basic uses of pyHam API and embedded tools at http://zoo.cs.ucl.ac.uk/tutorials/tutorial_pyHam_get_started.html.

Table of compatibility

Support for pyHam by various HOG inference resources.

Resource

Species tree format

OrthoXML

SUPPORT

OMA browser

PhyloXML and Newick

All HOGs , or one HOG at a time

YES

OMA standalone

PhyloXML and Newick

All HOGs

YES

Ensembl

Newick

one HOG at a time

YES

HieranoidDB

Newick

one HOG at a time

YES

Documentation

You can the full documentation of pyHam at http://zoo.cs.ucl.ac.uk/doc/pyham/index.html

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

pyham-1.1.4.tar.gz (76.5 kB view hashes)

Uploaded Source

Built Distribution

pyham-1.1.4-py2.py3-none-any.whl (35.6 kB view hashes)

Uploaded Python 2 Python 3

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