Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

SuppOrth

SuppOrth

SuppOrth runs OrthoFinder, SonicParanoid2 and Broccoli on your protein FASTA files and combines their orthologue predictions. You can also include results from an existing OMA run.

The output contains unique protein pairs between species, the tools supporting each pair, and alignment statistics when available. It accepts two or more proteomes and keeps one-to-many and many-to-many relationships.

Install

Use Python 3.10–3.12 on macOS or Linux. Create an environment, install SuppOrth, then install its predictors:

python3.10 -m venv .venv
source .venv/bin/activate
python -m pip install 'git+https://github.com/fma91/SuppOrth.git@stand_alone'
suppOrth install
suppOrth check

The first PyPI release is being prepared. Once published, replace the Git installation command with python -m pip install --pre supporth.

The predictors are installed from their source repositories under ~/.supporth. You need Git and a compiler toolchain. MAFFT and FastME must already be available or supplied during installation. SonicParanoid needs an indexed Pfam database; preparing it can take several hours. To reuse an existing database:

suppOrth install --pfam-db /path/to/profile_db

See the installation details for interpreter selection, shared binaries and custom installation locations.

Run

Put one protein FASTA per species in a directory:

suppOrth run -f proteomes/ -o results/ -t 8

Or pass the files directly:

suppOrth run speciesA.faa speciesB.faa speciesC.faa -o results/ -t 8

Use unique protein identifiers across the FASTAs. SuppOrth reads the first whitespace-separated field of each header. The predictors run sequentially, using the requested thread budget.

By default, a pair is kept if at least three tools support it, or its alignment identity is greater than 80%. Change the thresholds with:

suppOrth run -f proteomes/ -o results/ --supportLv 2 --identity_filter 90

Use --supportLv 1 to keep every predicted cross-species pair. Support counts measure agreement between methods; they are not probabilities.

Include OMA

Run OMA separately with the same protein identifiers, then supply its output:

suppOrth run -f proteomes/ -o results/ --oma /path/to/oma_run/Output/

SuppOrth imports OMA's PairwiseOrthologs tables as a fourth source of support. It does not install or run OMA. See the OMA guide for accepted folders and identifier matching.

Results

Open these files in results/:

  • suppOrth.tsv: protein pairs, support counts, 0/1 tool columns and alignment statistics.
  • suppOrth.png and suppOrth.svg: overlap figures from all predictor calls before filtering.
  • provenance.json: inputs, options, software versions and run status.

Tool labels are F (OrthoFinder), S (SonicParanoid), B (Broccoli) and O (OMA). For example, SupportedBy=F,S,O means three tools support the pair.

Protein-pair overlaps

The SuppOrth manual includes the first ten rows of an example output, all output files, native predictor options, BLAST/DIAMOND selection and maintenance commands.

More options

OrthoFinder uses DIAMOND, MAFFT and IQ-TREE by default. Select BLAST with --alignment blast. Pass native predictor arguments in a quoted string:

suppOrth run -f proteomes/ -o results/ --opt orthofinder="-I 2.0"

See the SuppOrth manual and release instructions.

Metadata

Release files for supporth 0.4.0rc1

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

Source distribution (sdist)

Source distribution for supporth 0.4.0rc1
File Size Uploaded
supporth-0.4.0rc1.tar.gz 69.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for supporth 0.4.0rc1
File Interpreter ABI Platform
supporth-0.4.0rc1-py3-none-any.whl Python 3 none any Details

Total release size: 131.2 kB

Release files / supporth-0.4.0rc1.tar.gz

Download URL supporth-0.4.0rc1.tar.gz
Size 69.9 kB
Tags Source
SHA-256 checksum
How to use checksums
b60269141dd4132f0d2a5962071b01bb0fd93404ba1b0e04817d51154996a725
BLAKE2b-256 checksum
How to use checksums
e22dda154053a53143684982a7c8f0038d07e8034b17a475492c295337282038
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.2

Release files / supporth-0.4.0rc1-py3-none-any.whl

Download URL supporth-0.4.0rc1-py3-none-any.whl
Size 61.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2bd0a72257204a4f85f09b4f605c5ad4ce3ffad533020555ad55c3f0568e05e4
BLAKE2b-256 checksum
How to use checksums
cfa4009793b9ba09f5eb28d7132afd96dfeb029ec8258783d4afd219cb0bcb96
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.2

Release history Release notifications | RSS feed

0.4.0

2 release files

This release

0.4.0rc1 This release

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