Skip to main content

HogProf

HogProf is an extensible and tunable approach to phylogenetic profiling using orthology data. It is powered by minhash-based data structures and computationally efficient.

Features

  • Using orthoxoml files and a taxonomy calculated enhanced phylogenies of each family
  • These are transformed into minhash signatures and a locally sensitive hashing forest object for search and comparison of profiles
  • Taxonomic levels and evolutionary event types (presence, loss, duplication) can have custom weight in profile construction
  • Optimization of weights using machine learning

If you run into any problems, feel free to contact me at dmoi@unil.ch

Quickstart

pip install hogprof

Install from sources

git clone https://github.com/DessimozLab/HogProf.git
cd HogProf
pip install .

Usage

Example: using the OMA database

Let's get a current version of the OMA hdf5 file and GAF. This will aloww us to use the HOGs and study the functional enrichment of our search results. Careful, this download is heavy (hundreds of GB):

mkdir YourOmaDirectory
cd YourOmaDirectory
wget https://omabrowser.org/All/OmaServer.h5
wget https://omabrowser.org/All/oma-go.txt.gz

The latest release (May.2026) is more than 300GB in size. Alternatively, you can use earlier releases, for example:

wget https://omabrowser.org/All.Jul2024/OmaServer.h5

which is 180GB in size. For other releases, check https://omabrowser.org/oma/archives/, select release and search for "OMA Browser database (as hdf5)".

We also need to make a location to store our pyprofiler databases

cd ..
mkdir YourHogProfDirectory

Let's now compile a database containing all HOGs and our desired taxonomic levels using default settings. Launch the lshbuilder as shown below. dbtypes available on the command line are: all, plants, archaea, bacteria, eukarya, protists, fungi, metazoa, and vertebrates. These will use the NCBI taxonomy as a tree to annotate events in different gene family's histories.

If you are using an OMA release before 2022 you will need to use the NCBI tree. This is the default tree used by HogProf.

lshbuilder --outpath YourHogProfDirectory --dbtype all --OMA YourOmaDirectory/OmaServer.h5 --nthreads numberOfCPUcores         

If you are using OMA releases after 2022 we will also be downloading the OMA taxonomic tree since it is more accurate than the NCBI tree. This will be used to annotate the events in the gene family histories.

wget https://omabrowser.org/All/speciestree.nwk

We are ready to use the OMA tree to build our database.

lshbuilder --outpath YourHogProfDirectory --dbtype all --OMA YourOmaDirectory/OmaServer.h5 --nthreads numberOfCPUcores --mastertree YourOmaDirectory/speciestree.nwk --reformat_names True

This should build a taxonomic tree for the genomes contained in the release and then calculate enhanced phylogenies for all HOGs in OMA.

Once the database is completed it can be interogated using a profiler object. Construction and usage of this object should be done using a python script or notebook. This shown in the example notebook searchenrich.ipynb found in the examples. Please feel free to modify it to suit the needs of your own research.

Metadata

Release files for HogProf 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for HogProf 0.1.0
File Size Uploaded
hogprof-0.1.0.tar.gz 36.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for HogProf 0.1.0
File Interpreter ABI Platform
hogprof-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 72.8 kB

Release files / hogprof-0.1.0.tar.gz

Download URL hogprof-0.1.0.tar.gz
Size 36.5 kB
Tags Source
SHA-256 checksum
How to use checksums
9509503d7074f4594e9e8b1c40e0ada5b3270e4b493cb8e7a147d80085537d17
BLAKE2b-256 checksum
How to use checksums
6d3170b4c1ea41751ed97bcd115b3c3c50845f0d441997aab29a70ed29931994
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / hogprof-0.1.0-py3-none-any.whl

Download URL hogprof-0.1.0-py3-none-any.whl
Size 36.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
15f22b6dbf1e82480b35abfd201ee40b6b504abbd536cc538c6c02dff4703d1a
BLAKE2b-256 checksum
How to use checksums
953fef83e4a4ffb6338a098c1c4584e9ca38714ae6604d050f5aa954641b2dd4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

0.2.0

2 release files

This release

0.1.0 This release

2 release files

0.0.12

2 release files

0.0.11

2 release files

0.0.10

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.3

2 release files

0.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page