Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/datasnakes/orthoevolution
An easy to use and comprehensive python package which aids in the analysis and visualization of orthologous genes. 🐵
https://github.com/datasnakes/orthoevolution
bash bioinformatics biology biosql blast data-science ftp genetics ncbi orthologs orthologues orthology orthology-inference pbs phylogenetics python qsub sequence-alignment sge shell
Last synced: about 1 month ago
JSON representation
An easy to use and comprehensive python package which aids in the analysis and visualization of orthologous genes. 🐵
- Host: GitHub
- URL: https://github.com/datasnakes/orthoevolution
- Owner: datasnakes
- Created: 2017-04-14T16:11:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-31T06:52:34.000Z (2 months ago)
- Last Synced: 2024-11-10T18:54:50.342Z (about 2 months ago)
- Topics: bash, bioinformatics, biology, biosql, blast, data-science, ftp, genetics, ncbi, orthologs, orthologues, orthology, orthology-inference, pbs, phylogenetics, python, qsub, sequence-alignment, sge, shell
- Language: Python
- Homepage: https://orthoevolution.readthedocs.io/en/master/
- Size: 40.7 MB
- Stars: 29
- Watchers: 4
- Forks: 4
- Open Issues: 34
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
Awesome Lists containing this project
README
.. image:: https://travis-ci.org/datasnakes/OrthoEvolution.svg?branch=master
:target: https://travis-ci.org/datasnakes/OrthoEvolution
.. image:: https://badge.fury.io/py/OrthoEvol.svg
:target: https://badge.fury.io/py/OrthoEvol
.. image:: https://readthedocs.org/projects/orthoevolution/badge/?version=latest
:target: http://orthoevolution.readthedocs.io/en/latest/?badge=latest
.. image:: https://codecov.io/gh/datasnakes/OrthoEvolution/branch/master/graph/badge.svg
:target: https://codecov.io/gh/datasnakes/OrthoEvolution
.. image:: https://badgen.net/github/last-commit/datasnakes/OrthoEvolution
:target: https://github.com/datasnakes/OrthoEvolution/commits/master
.. image:: https://img.shields.io/badge/chat-on%20gitter-753A88.svg
:target: https://gitter.im/datasnakes/OrthoEvolution
OrthoEvolution
====================
OrthoEvolution is an **easy to use** and comprehensive python package which aids in the **analysis and
visualization of comparative evolutionary genetics** related projects such as the **inference of orthologs**.
Overview
--------------------------
This package focuses on **inferring orthologs** using NCBI's blast, various sequence alignment strategies,
and phylogenetics analyses including PAML, PhyML, ete3, and more tools.
Ultimately, the goal of this project is to create a **reusable pipeline** for the
inference of orthologs in order to ensure reproducibility of data as well as improve
the management and analysis of (what can be) large datasets. The Cookies, Manager, Pipeline,
and Tools modules act as a framework for our workflow, while the Orthologs
module provides access to specific functions for our various ortholog inference projects.
View our `read the docs `__ and feel free to also
read `this related paper `__ to gain
more insight into this project/python package.
Installation
----------------
View the below methods for installing this package. Python3.5 and higher is required.
PyPi
~~~~~~~~~~~~~~~~
``pip install OrthoEvol``
GitHub
~~~~~~~~~~~~~~~~
1. Download the zip file and unzip it or ``git clone https://github.com/datasnakes/OrthoEvolution.git``
2. ``cd OrthoEvolution``
3. ``pip install .``
Development Code
~~~~~~~~~~~~~~~~
**WARNING** : This code is actively under development and may not be reliable. Please create an `issue `_ for questions about development.
1. Download the zip file and unzip it or ``git clone -b dev-master https://github.com/datasnakes/OrthoEvolution.git``
2. ``cd OrthoEvolution``
3. ``pip install .``
Examples
----------------
Check out this `tutorial `__ in our Wiki Docs.
Also, please view `examples `__ of how to utilize this package to build tools.
Running a pre-configured local blast
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code:: python
from OrthoEvol.Orthologs.Blast import OrthoBlastN
# Use an existing list of gpcr genes
gpcr_blastn = OrthoBlastN(project="orthology-gpcr", method=1,
save_data=True, acc_file="gpcr.csv",
copy_from_package=True)
# Run blast
gpcr_blastn.run()
Simple project creation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code:: python
from OrthoEvol.Manager.management import ProjectManagement
ProjectManagement(repo="test-repo", user=None,
project="test-[roject",
research=None,
research_type='comparative_genetics',
new_repo=False, new_user=False, new_project=True,
new_research=False)
Simple blast database downloading
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code:: python
from OrthoEvol.Tools.ftp import NcbiFTPClient
ncbiftp = NcbiFTPClient(email='[email protected]')
ncbiftp.getblastdb(database_name='refseq_rna', v5=True)
Creating projects and databases dynamically
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code:: python
from OrthoEvol.Manager.management import ProjectManagement
from OrthoEvol.Manager.database_dispatcher import DatabaseDispatcher
from OrthoEvol.Manager.config import yml
from pkg_resources import resource_filename
from pathlib import Path
import yaml
# Set up project management
pm_config_file = resource_filename(yml.__name__, "initialize_new.yml")
with open(pm_config_file, 'r') as f:
pm_config = yaml.load(f)
pm = ProjectManagement(**pm_config["Management_config"])
# Set up database management
db_config_file = resource_filename(yml.__name__, "databases.yml")
with open(db_config_file, 'r') as f:
db_config = yaml.load(f)
config = db_config.update(pm_config)
# Generate main config file for this job
config_file = pm.user_log / Path("upload_config.yml")
with open(str(config_file), 'w') as cf:
yaml.dump(config, cf, default_flow_style=False)
# Set up database dispatcher and dispatch the functions
dd = DatabaseDispatcher(config_file, pm)
dd.dispatch(dd.strategies, dd.dispatcher, dd.configuration)
Tests
----------------
To run tests, type ``pytest tests`` in the OrthoEvolution directory.
First, install the ``pytest` package using pip.
Contributors
----------------
This package was created by the Datasnakes.
- Rob Gilmore \| Github: `@grabear `__ \|
`✉ `__
- Shaurita Hutchins \| Github:
`@sdhutchins `__ \|
`✉ `__
If you would like to contribute to this package, install the package in development mode,
and check out our `contributing guidelines `__.
Citations
----------------
We're so thankful to have a resource such as
`Biopython `__. They inspired this
package.
*Cock, P.J.A. et al. Biopython: freely available Python tools for
computational molecular biology and bioinformatics. Bioinformatics 2009
Jun 1; 25(11) 1422-3 http://dx.doi.org/10.1093/bioinformatics/btp163
pmid:19304878*