Skip to main content

benchmarking gene regulatory networks

Project description

bengrn

codecov CI PyPI version Documentation Status 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 more in the notebooks in the docs folder or in the documentation

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.0.1.tar.gz (52.2 kB view details)

Uploaded Source

Built Distribution

bengrn-1.0.1-py3-none-any.whl (56.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bengrn-1.0.1.tar.gz
  • Upload date:
  • Size: 52.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.4 Linux/5.15.0-107-generic

File hashes

Hashes for bengrn-1.0.1.tar.gz
Algorithm Hash digest
SHA256 0c1c1b1d3b0bd44fa2ce8a72d6c8ee4956df95ff34eea198c7ba5f3b1c22a6cf
MD5 f4ac0f79d95c8c68d3a9a5cc1ef66913
BLAKE2b-256 1e28d86ff43c47035ce3134106d0ecf63c65678efeb0dfcdb50fbdf65fd4c461

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bengrn-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 56.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.4 Linux/5.15.0-107-generic

File hashes

Hashes for bengrn-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ed3d844c9ce73eb059597a4e7f1c4fff70c6baf980f79bdca051fb06cb25bbdb
MD5 8775b295786ad9f4821d4fbe61ef2b9f
BLAKE2b-256 96b7502bbce8b928b974cbc3b559a23fe910531642c802fe7d77aed2cf65698f

See more details on using hashes here.

Supported by

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