Skip to main content

Human Cytokine Dictionary

Project description

huCIRA

Tests Documentation

huCIRA (human Cytokine Immune Response Analysis) provides an easy-to-use interface to analyze cytokine signaling and cytokine-induced immune program enrichment in transcriptomic datasets.

To get started, simply supply a transcriptomic dataset annotated with immune cell types and the experimental conditions of interest. Using our dictionary as a reference, huCIRA allows you to infer differential cytokine activity and immune program activation across conditions and to map cytokine-mediated interactions between immune cells. Under the hood, huCIRA is based on gseapy to run enrichment analyses.

huCIRA

Getting started

Please refer to this tutorial for an example of a full pipeline.

The core analysis is happening here:

import scanpy as sc
import hucira as hc

# 1. Load your data
adata = sc.read_h5ad("your_transcriptome.h5ad")
human_cytokine_dictionary = hc.load_human_cytokine_dict()

# 2. Run cytokine enrichment analysis for B cells between healthy and diseased patients
enrichment_results = hc.run_one_enrichment_test(
    adata = adata,
    df_hcd_all = human_cytokine_dictionary,
    contrasts_combo = ("healthy", "disease"),
    celltype_combo = ("B cell", "B"),
    contrast_column = "condition",
    celltype_column = "cell_type",
    direction = "upregulated",
    threshold_expression = 0.0
)

# 3. Investigate enrichment scores of cytokines in your data
enrichment_results

Installation

You need to have 3.11 <= Python < 3.14 installed on your system. If you don't have Python installed, we recommend installing uv.

There are several alternative options to install hucira:

  1. Install the latest development version:
pip install git+https://github.com/theislab/huCIRA.git@main

Release notes

See the changelog.

Contact

If you found a bug, please use the issue tracker.

Citation

t.b.a

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

hucira-0.0.1.tar.gz (318.5 kB view details)

Uploaded Source

Built Distribution

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

hucira-0.0.1-py3-none-any.whl (59.8 kB view details)

Uploaded Python 3

File details

Details for the file hucira-0.0.1.tar.gz.

File metadata

  • Download URL: hucira-0.0.1.tar.gz
  • Upload date:
  • Size: 318.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hucira-0.0.1.tar.gz
Algorithm Hash digest
SHA256 4eb5d054fcac9cd9fd19fb8c61ab4b8035c76c775380202cf0ec97b1ce6a3e9f
MD5 dd3305e306b2a0e5fdc224bd43bdb6c0
BLAKE2b-256 89f33a6f1379ac114b0da1826ec9a75ef8f143d6314c703d8be57ea2aa86ab40

See more details on using hashes here.

Provenance

The following attestation bundles were made for hucira-0.0.1.tar.gz:

Publisher: release.yaml on theislab/huCIRA

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

File details

Details for the file hucira-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: hucira-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 59.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hucira-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a297db4ceda26f75e5bdf3ae81535b6bd078dcab747e33266799e333067a9352
MD5 65022035b0c4f5f7fa64993b04432a39
BLAKE2b-256 3a358e62c50e9683aa2735af1ee254649da0c64013c8e4fc076cd9a8fd6fade5

See more details on using hashes here.

Provenance

The following attestation bundles were made for hucira-0.0.1-py3-none-any.whl:

Publisher: release.yaml on theislab/huCIRA

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