Skip to main content

bengrn

codecov CI PyPI version Downloads Downloads Downloads GitHub issues Code style: black DOI

Benchmark your gene regulatory networks inference algorithm (from scRNAseq or bulk RNAseq dataset) with BenGRN

The package is supposed to work with GRnnData and only uses biological ground truth datasets.

It can run Genie3 & pyscenic on your data as a comparison

It has 3 main different types of key ground truth data to compare your GRN to:

  • Mc Calla et al.'s ChIP+Perturb ground truth
  • omnipath's literature curated ground truth
  • genome wide perturb seq 's dataset

You can find the documentation here

Install it from PyPI

pip install bengrn

Install it locally and run the notebooks:

git clone https://github.com/jkobject/benGRN.git
pip install -e benGRN

Usage

from bengrn import BenGRN
from bengrn import some_test_function

# a GRN in grnndata formart
grndata

BenGRN(grndata).do_tests()
#or
some_test_function(grndata)

see the notebooks in docs:

  1. omnipath
  2. genome wide perturb seq
  3. Mc Calla

/!\ offline mode

If you want to run the notebooks offline, you need to download the data first.

from bengrn import download_perturb_gt, download_GT_db, download_sroy_gt

download_perturb_gt()

Development

Read the CONTRIBUTING.md file.

Awesome Benchmark of Gene Regulatory Networks created by @jkobject

Metadata

Release files for benGRN 1.3.2

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

Source distribution (sdist)

Source distribution for benGRN 1.3.2
File Size Uploaded
bengrn-1.3.2.tar.gz 24.6 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for benGRN 1.3.2
File Interpreter ABI Platform
bengrn-1.3.2-py3-none-any.whl Python 3 none any Details

Total release size: 30.8 MB

Release files / bengrn-1.3.2.tar.gz

Download URL bengrn-1.3.2.tar.gz
Size 24.6 MB
Tags Source
SHA-256 checksum
How to use checksums
f57fed7f6a7c0db89acf34c549b4c74d6690d280935a2451981d608ef9351166
BLAKE2b-256 checksum
How to use checksums
442c6d40ced8721a89324419b225eabe79a60c5764c0ea5f5901548593a49d2c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / bengrn-1.3.2-py3-none-any.whl

Download URL bengrn-1.3.2-py3-none-any.whl
Size 6.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
0f55aa1f3869d770e28deed731f340d0abff0fd41f0cb1feec3759fcdd0240b5
BLAKE2b-256 checksum
How to use checksums
b9578c03505c311dee5a9b6ef360912217501c0d325e4132e182f80840f31b47
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

This release

1.3.2 This release

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.4

2 release files

1.2.2

2 release files

1.1.2

1 release file

1.1.0

2 release files

1.0.7

2 release files

1.0.5

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.1.0

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