Evidome
Evidome turns a gene-level differential expression result into a structured, self-describing functional evidence report: gene-set enrichment (Reactome, Gene Ontology, WikiPathways, MSigDB Hallmark; ORA and preranked GSEA) and upstream-regulator evidence (CollecTRI and OmniPath), written for an AI agent to read and interpret. The program itself makes no interpretive claims.
It works across species. It identifies the species from the input's Ensembl gene IDs, maps every gene to its human ortholog (Ensembl Compara), records how each mapping was made, and resolves many-to-one orthologs by majority vote across the statistics.
Evidome is standalone software. Paralome runs it as an external tool, but nothing about Evidome depends on Paralome.
Install
python3 -m pip install . # from a copy of this repository
Requires Python 3.9 or later. pip installs the two required packages,
matplotlib and scikit-learn (see NOTICE).
Reference data
Fetched once per machine, which needs internet access for this step:
evidome reference genesets
evidome reference regulators
evidome reference pathway-signs
evidome reference fetch --species <name> # per species
The first three are shared by every species. A run on a species that has not been fetched fetches it by itself.
Use
evidome TABLE --out DIR # every step, on this machine
evidome TABLE --out DIR --backend slurm # every step, as SLURM jobs
evidome --help # the individual steps
Input
TABLE is one of:
- a wide statistics table: one row per gene, an Ensembl gene ID column, and a
block of columns per comparison (
<name>_P-value,<name>_Q-value, and<name>_Log2_fold_changeor<name>_Fold_change); - one comparison's table, or a folder of them (one comparison per file, named after the file), which is combined into a wide table first;
- results tables from DESeq2, edgeR, limma or Seurat's FindMarkers, written
from R as they come (
write.csv(...)), one comparison per file, read by their own column names.
Gene IDs may be Ensembl gene IDs or NCBI GeneIDs, whose species is found from
the IDs, or gene symbols, which need the species named: --species macaca_mulatta. Symbols and NCBI GeneIDs are translated to the species'
Ensembl genes; an ID that names no gene, or several, is kept and reported,
never guessed. A folder is read for its .csv, .tsv and .txt files.
evidome inspect TABLE shows what Evidome reads from a table without running
anything. The full format -- every column, the comment header, F-tests,
gene-burden tests, what each column is used for, what is refused and why --
is in src/evidome/docs/INPUT_FORMAT.md,
which is also installed with the package.
Output
The evidence zip (<out>_combined_results.zip) holds every table as CSV, a
manifest that describes each file and column, and
Evidome_Viewer_v<version>.html, a page for browsing the results. Beside the
zip, <out>_workbook.xlsx shows the same tables as one workbook. Open the
page in a web browser (unzipped beside the files, or on its own) and choose
the zip or the unzipped folder. It lists the findings, ORA, GSEA, regulators
and genes of each comparison, with a pop-up per gene set, regulator and gene
that exports as TSV. The page reads the files on your computer and uploads
nothing.
Develop
python3 -m pytest # from the repository root
PYTHONPATH=src python3 -m evidome.cli --version
Licence
Copyright (C) 2026 Kenneth L. Jones. Dual licensed: the GNU Affero General
Public License, version 3 (see LICENSE), or a separate commercial licence.
See NOTICE, which also lists the reference data sources and their licences.
Metadata
Release files for evidome 1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| evidome-1.0.tar.gz | 260.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| evidome-1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 471.6 kB
Release files / evidome-1.0.tar.gz
| Download URL | evidome-1.0.tar.gz |
|---|---|
| Size | 260.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8c84dffafb7e1890af081c4a95a6c21470ff942e1c4efb3ccab36317ffe676c6
|
|
BLAKE2b-256 checksum How to use checksums |
0df8dd9fcf75a963c856e5b2d0031076506f053fa095905feabd9172e15bf1bd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.7
|
Release files / evidome-1.0-py3-none-any.whl
| Download URL | evidome-1.0-py3-none-any.whl |
|---|---|
| Size | 211.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f9c8696d05fdf17d832346526c24edaddb4a20dcf8669eb502e33bbc568fa58f
|
|
BLAKE2b-256 checksum How to use checksums |
33429c04d54cf382b2d254800e9a5dcbebb78851d75d3f45d76f299685be73a5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.7
|