Skip to main content

BioProcessDB local biological knowledge base and BioProcess-miR process→gene→miRNA analysis

Project description

BioProcess-miR

Local, reproducible biological knowledge base (BioProcessDB) and disease-agnostic process → gene → microRNA analysis (BioProcess-miR) — v1.0.0.

What BioProcess-miR does

  • Builds and queries a local DuckDB + Parquet knowledge base (HGNC, GO, Reactome, WikiPathways, optional KEGG under safeguard, miRTarBase).
  • Resolves biological processes, expands membership, links experimentally supported miRNA–target evidence, runs explicit-universe enrichment, applies transparent prioritization policies, and generates provenance-rich reports.

What it does not do

  • Disease-specific scoring, SH-SY5Y logic, expression integration, network propagation, ML ranking, therapeutic recommendation, or causal inference.
  • Opaque composite “best miRNA” scores by default (components_only_v1).
  • Redistribution of restricted KEGG pathway content.

Architecture

Layer Import / CLI Role
BioProcessDB bioprocessdb / bioprocessdb Download, normalize, store, query
Analysis same package ProcessEngine → Linker → Enrichment → Prioritization → Reporter
Thin façade bioprocess_mir Compatibility CLI wrapper

Canonical gene key: HGNC ID. Schema version 1.1.0 (independent of package 1.0.0).

Installation

pip install bioprocessdb
pip install "bioprocessdb[stats]"       # scipy / statsmodels
pip install "bioprocessdb[reporting]"   # matplotlib PNG export
pip install "bioprocessdb[all]"         # stats + reporting + dev tooling

Python 3.11+. Optional groups: stats, reporting, notebook, test, dev, docs, all.

Quick example

# Offline demonstration database (synthetic/minimal fixtures — NOT production)
python scripts/build_demo_database.py --overwrite
bioprocessdb --config demos/demo_v1/config/default.yaml analyze \
  --record GO:GO:0006979 \
  --include-descendants \
  --universe mirtarbase-eligible-targets \
  --policy components_only_v1 \
  --report html \
  --output results/examples/oxidative_stress

bioprocessdb --config demos/demo_v1/config/default.yaml run examples/oxidative_stress.yaml
from bioprocessdb import (
    BioProcessDB,
    ProcessEngine,
    ProcessMiRNALinker,
    MiRNATargetEnrichment,
    MiRNAPrioritization,
    BioProcessMiRReporter,
)

db = BioProcessDB("demos/demo_v1/database/bioprocess.duckdb")

Outputs

Under results/: process queries, process–miRNA links, enrichment, prioritization, and HTML/Markdown/JSON reports with manifests and fingerprints.

Provenance

Every analysis records package/schema/module versions, database build_id, source versions, query parameters, and result fingerprints. See docs/reproducibility.md.

Limitations

  • Quality of results depends on local database completeness and upstream evidence.
  • Demo fixtures are tiny and synthetic — not for biological conclusions.
  • KEGG is optional and restricted; exports are gated.
  • Enrichment significance ≠ biological importance or therapeutic utility.

Citation

See CITATION.cff and docs/data_licenses.md. Cite BioProcess-miR software separately from HGNC, GO, Reactome, WikiPathways, miRTarBase, and KEGG (when used).

Documentation

License

MIT for project code. Upstream databases retain their own terms — notably KEGG redistribution restrictions. See docs/data_licenses.md.

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

bioprocessdb-1.0.0.tar.gz (268.6 kB view details)

Uploaded Source

Built Distribution

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

bioprocessdb-1.0.0-py3-none-any.whl (347.7 kB view details)

Uploaded Python 3

File details

Details for the file bioprocessdb-1.0.0.tar.gz.

File metadata

  • Download URL: bioprocessdb-1.0.0.tar.gz
  • Upload date:
  • Size: 268.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for bioprocessdb-1.0.0.tar.gz
Algorithm Hash digest
SHA256 1e42aa78626cc4dcb88b56902a4422f2252a7a60e9ec16a4a3ea584b985c11fa
MD5 bacc7ab6620085f0cbd0ea3de111a5cf
BLAKE2b-256 cd2dcc6421fd8147e1093b2948eb335b097c11bece383e57c09fe297ad58ea62

See more details on using hashes here.

File details

Details for the file bioprocessdb-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: bioprocessdb-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 347.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for bioprocessdb-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a2bcc2ac67a569d34487aa9b011d14444834c134d944a2a793b610988c0d15c1
MD5 e41ef689759f729835aa23f98df93d07
BLAKE2b-256 2e8e4318a0e32c52703499f4d2715bf3b4db62d343ba2e180c3f9c9436bda51f

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