Skip to main content

orthofisher

Project description

Logo

Docs · Report Bug · Request Feature

follow on Twitter


Orthofisher conducts automated and high-throughout identification of a predetermined set of orthologs, which can be used for phylgenomics, gene family copy number determination and more!

If you found orthofisher useful, please cite orthofisher: a broadly applicable tool for automated gene identification and retrieval. Steenwyk & Rokas 2021, G3 Genes|Genomes|Genetics. doi: 10.1093/g3journal/jkab250.



Guide

Quick Start
Performance Assessment
FAQ




Quick Start

For detailed instructions on usage and a tutorial, please see the online documentation.


1) Prerequisite

Before installing orthofisher, please first install HMMER3 and add the HMMER to your .bashrc path. For example, my .bashrc has the following:

export PATH=$PATH:/home/steenwj/SOFTWARE/hmmer-3.1b2-linux-intel-x86_64/binaries

2) Install orthofisher

If you are having trouble installing orthofisher, please contact the lead developer, Jacob L. Steenwyk, via email or twitter to get help.


To install via anaconda, execute the follwoing command:

conda install -c jlsteenwyk orthofisher

Visit here for more information: https://anaconda.org/jlsteenwyk/orthofisher


To install via pip, execute the follwoing command:

pip install orthofisher

To install from source, execute the follwoing command:

# download
git clone https://github.com/JLSteenwyk/orthofisher.git
# change dir
cd orthofisher/
# install
make install

If you run into software dependency issues, install orthofisher in a virtual environment. To do so, create your virtual environment with the following command:

# create virtual environment
python -m venv .venv
# activate virtual environment
source .venv/bin/activate

Next, install the software using your preferred method above. Thereafter, you will be able to use orthofisher.

To deactivate your virtual environment, use the following command:

# deactivate virtual environment
deactivate

Note, the virtual environment must be activated to use orthofisher.




Performance Assessment

Using 1,530 sequence similarity searches across six model eukaryotic proteomes, the performance of orthofisher was compared to results obtained from BUSCO. Examination of precision and recall revealed near perfect performance. More specifically, orthofisher had a recall of 1.0 and precision of 0.99. Precision is less than 1.0 because priors of expected sequence length and sequence similarity scores--which are not implemented in orthofisher--resulted in more missing genes in the BUSCO pipeline than the orthofisher pipeline.




FAQ


I am having trouble installing orthofisher, what should I do?

Please install orthofisher using a virtual environment as described in the installation instructions. If you are still running into issues after installing in a virtual environment, please contact Jacob L. Steenwyk via email or twitter.




orthofisher is developed and maintained by Jacob Steenwyk

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

orthofisher-1.1.1.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

orthofisher-1.1.1-py2.py3-none-any.whl (12.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file orthofisher-1.1.1.tar.gz.

File metadata

  • Download URL: orthofisher-1.1.1.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for orthofisher-1.1.1.tar.gz
Algorithm Hash digest
SHA256 0a71d21864db9e104eefd636e0185969fb5da25a01770b578966aca75517c046
MD5 45c323cec5426392f2535036403d0c5b
BLAKE2b-256 b76c471aa1953a553047df38a8186b7e260c4d7949a9bb6feef52d9709d34558

See more details on using hashes here.

File details

Details for the file orthofisher-1.1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for orthofisher-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c206ee7daa2afae18a207ddf4c41466d3b212a0dafa09dded4ba62afdfcb3cac
MD5 12ce1fccabe32b82547546b2f7774d32
BLAKE2b-256 f6c58b2c6ac112fe842df5776a63ba58dbde2791994acb842c7b4c693e8829e4

See more details on using hashes here.

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