Skip to main content

benchmarking gene regulatory networks

Project description

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

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

bengrn-1.3.2.tar.gz (24.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bengrn-1.3.2-py3-none-any.whl (6.2 MB view details)

Uploaded Python 3

File details

Details for the file bengrn-1.3.2.tar.gz.

File metadata

  • Download URL: bengrn-1.3.2.tar.gz
  • Upload date:
  • Size: 24.6 MB
  • Tags: Source
  • Uploaded using 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}

File hashes

Hashes for bengrn-1.3.2.tar.gz
Algorithm Hash digest
SHA256 f57fed7f6a7c0db89acf34c549b4c74d6690d280935a2451981d608ef9351166
MD5 ba01e447811644cbd10b0cdf9a516287
BLAKE2b-256 442c6d40ced8721a89324419b225eabe79a60c5764c0ea5f5901548593a49d2c

See more details on using hashes here.

File details

Details for the file bengrn-1.3.2-py3-none-any.whl.

File metadata

  • Download URL: bengrn-1.3.2-py3-none-any.whl
  • Upload date:
  • Size: 6.2 MB
  • Tags: Python 3
  • Uploaded using 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}

File hashes

Hashes for bengrn-1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0f55aa1f3869d770e28deed731f340d0abff0fd41f0cb1feec3759fcdd0240b5
MD5 a0ffc18881ac8b59c2d8ae8c5c39d634
BLAKE2b-256 b9578c03505c311dee5a9b6ef360912217501c0d325e4132e182f80840f31b47

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page