Skip to main content

Bioinformatics toolkit for upstream and downstream analyses around the BoNesis framework

Project description

tests PyPI python license

BoNesisTools

BoNesisTools provides Python-implemented toolkits for upstream and downstream analyses around the BoNesis ecosystem.

The package provides:

  • Boolean algebra and partial Boolean abstractions
  • Boolean network manipulation and analysis
  • signed influence graph utilities
  • GRN-informed Boolean predecessor inference
  • single-cell and multimodal analysis helpers
  • biological database interfaces

Usage

import bonesistools as bt

BoNesisTools exposes four main namespaces:

  • bt.sct — single-cell and multimodal annotated data tools
  • bt.bpy — Boolean modelling and graph utilities
  • bt.dbs — biological database interfaces
  • bt.grn — deprecated alias for bt.bpy.ig

Single-cell tools

bt.sct is inspired by Scanpy while providing additional and complementary features for single-cell analyses.

Submodules:

  • preprocessing: bt.sct.pp

    • gene name harmonization
    • metadata transfer utilities
    • lightweight preprocessing helpers
  • tools: bt.sct.tl

    • K-nearest-neighbor and shared-neighbor graph utilities
    • marker and log-fold-change analysis
    • regression and matrix conversion utilities
  • plotting: bt.sct.pl

    • embedding, density, composition and graph visualizations
    • distribution utilities
  • datasets: bt.sct.datasets

    • packaged reference datasets

Boolean modelling utilities

bt.bpy provides utilities for Boolean modelling, logical abstractions and signed regulatory graphs.

Submodules:

  • Boolean algebra: bt.bpy.ba

    • partial Boolean abstractions and hypercube representations
    • Boolean differential and predecessor inference utilities
  • Boolean network: bt.bpy.bn

    • Boolean network manipulation and analysis
    • fixed-point computation
    • .bnet import/export
  • influence graph: bt.bpy.ig

    • signed regulatory influence graphs
    • feedback circuit and SCC analysis
    • signed interaction scoring from bounded walks
    • graph compression and visualization utilities

Example:

bn = bt.bpy.bn.BooleanNetwork(
    {
        "A": "B & ~C",
        "B": 1,
        "C": 0,
    }
)

graph = bn.to_influence_graph()

graph.show()

Biological external resources

bt.dbs provides lightweight interfaces and utilities for biological external resources.

Submodules:

  • NCBI: bt.dbs.ncbi

    • gene synonym harmonization
    • gene annotation utilities
  • OmniPath: bt.dbs.omnipath

    • DoRothEA transcription factor interactions
    • CollecTRI regulatory interaction networks
  • HCOP: bt.dbs.hcop

    • orthology mappings

Example:

genesyn = bt.dbs.ncbi.genesyn()

grn = bt.dbs.omnipath.collectri(
    organism="mouse",
    genesyn=genesyn,
)

Installation

Install the latest release:

pip install bonesistools

Install the single-cell dependencies:

pip install "bonesistools[sctools]"

Install all optional dependencies:

pip install "bonesistools[all]"

Install the development version:

git clone https://github.com/bnediction/bonesistools.git
cd bonesistools
pip install -e ".[all]"

or directly:

pip install git+https://github.com/bnediction/bonesistools.git

Bugs

Please report bugs or ask questions here:

https://github.com/bnediction/bonesistools/issues


License

This package is distributed under the CeCILL v2.1 free software license (GNU GPL compatible).

This package also includes third-party data resources derived from the NCBI Gene database (gene_info). NCBI places no restrictions on the use or redistribution of these data: https://www.ncbi.nlm.nih.gov/home/about/policies/

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

bonesistools-1.2.5.tar.gz (8.8 MB view details)

Uploaded Source

Built Distribution

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

bonesistools-1.2.5-py3-none-any.whl (8.8 MB view details)

Uploaded Python 3

File details

Details for the file bonesistools-1.2.5.tar.gz.

File metadata

  • Download URL: bonesistools-1.2.5.tar.gz
  • Upload date:
  • Size: 8.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bonesistools-1.2.5.tar.gz
Algorithm Hash digest
SHA256 4af6d2ce23f2d005f4b2276710e2df0a11ae5a24e2ed76d631c9003adb32de6e
MD5 b46b5487f4155e8550457252483e5c30
BLAKE2b-256 a3af889f77fa77ff481713b2d6f4a78b5515ba6d4dd8f4187bf2037c5324d16c

See more details on using hashes here.

Provenance

The following attestation bundles were made for bonesistools-1.2.5.tar.gz:

Publisher: publish.yml on bnediction/bonesistools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bonesistools-1.2.5-py3-none-any.whl.

File metadata

  • Download URL: bonesistools-1.2.5-py3-none-any.whl
  • Upload date:
  • Size: 8.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bonesistools-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 582b7272c0d91c94dbaab4bd1817596c0e4f9455d34c921bc55f1184aad46957
MD5 f9973898b885d76e2108086a3dd49964
BLAKE2b-256 7e317a2be41145b456b7e5c33048373a0f6a796a5daad396d788601bdd64e0db

See more details on using hashes here.

Provenance

The following attestation bundles were made for bonesistools-1.2.5-py3-none-any.whl:

Publisher: publish.yml on bnediction/bonesistools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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