Skip to main content

orthofisher

Project description

Logo

Docs · Report Bug · Request Feature

follow on Twitter

Support me on Patreon


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.0.5.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

orthofisher-1.0.5-py2.py3-none-any.whl (12.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: orthofisher-1.0.5.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

File hashes

Hashes for orthofisher-1.0.5.tar.gz
Algorithm Hash digest
SHA256 119e5d9daa05dffa326c89f8ebb5076b811dc813dd523c57595c210c7d849866
MD5 79a8ba423094f91cdcd02f4300313751
BLAKE2b-256 020d1ac50ece3d14be5877126b371bf5d6389e4c494dd46600e3acaace9c6a94

See more details on using hashes here.

File details

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

File metadata

  • Download URL: orthofisher-1.0.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 12.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

File hashes

Hashes for orthofisher-1.0.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3022d32345015505f5996520f2e68ac2ff84f73ae6612174ab97d7b1021212f2
MD5 94be94e49bc52b197cef1232b2ab7f23
BLAKE2b-256 a9a9bfa1ef4b40c102e7d5e9d5ac5c90b2968e273c658118b6c58b6b8ffc6991

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