Skip to main content

A toolkit for regulatory comparison using AUCell and RSS

Project description


alt text

Let me know if you need further customization or changes! Email: mapostol@unmc.edu

FOX: Functional OMIC eXploration of Gene Regulatory Networks

FOX is a highly modular and flexible methodology for analyzing and comparing gene-regulatory networks, especially in single-cell gene expression data. It integrates several advanced tools, including SCENIC, NMF, and Kendall's Tau, to provide deep insights into gene regulation. FOX can be used to visualize, compare, and analyze the structure and activity of gene regulatory networks under different conditions.

📘 Website Documentation

Installation (test)

pip install FOXREG==0.1.0

Usage

To run FOX, you'll need to prepare your data (such as RSS matrices and metadata) and pass it to the class. Here's an example of how to initialize and use FOX:

        data = pd.read_csv("QA_QC_PBMC_rss_values_Feb3.csv") ## this would be one comparison (RSS)
        df_RAS = pd.read_csv("obj_AUC_metadata2_PBMC.csv") ## grab this from your SCENIC stuff, include ALL METADATA AUC AND cellLabels

        labels = data.columns[1:].tolist()

        # your new labels here is your "tissue" or "cell" column
        comparison = ComparisonTree("Naive CD4 T", df_RAS, "newLabels", data, labels, "Unnamed: 0", "3.5_AUCellThresholds_Info_PVMC_QA_QC.tsv")


        comparison.construct_tree() 
        p_vals = comparison.plotRSS_NMF("B", drawQuadrants=True, include_pvals=True)
        comparison.plot_3dEmbedding(rawRSS=False)
        comparison.analyze_factors("B", percentages=True)
        comparison.compareLayers("B", "Naive CD4 T", 0.055)
        tr = comparison.create_global_tree()
        tree, dict = tr

Example Workflow:

  1. Prepare your single-cell gene expression data (e.g., CSV format).
  2. Initialize FOX with the necessary data, including control and treatment conditions.
  3. Compare gene-regulatory layers across conditions using the compareLayers function.
  4. Visualize the network structure using 2D and 3D plots.
  5. Assess the reproducibility of the regulatory network using the global tree structure.
  6. Analyze factors and clusters with advanced statistical methods and visualize the results.

Contributions

Contributions are welcome! Feel free to fork the repository and submit pull requests for bug fixes, new features, or improvements. Help us improve FOX!

Code style: black

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

foxreg-0.1.1.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

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

foxreg-0.1.1-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file foxreg-0.1.1.tar.gz.

File metadata

  • Download URL: foxreg-0.1.1.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.19

File hashes

Hashes for foxreg-0.1.1.tar.gz
Algorithm Hash digest
SHA256 e9b43a2eaa3379b8fba25de020dc5bcb52ccb7e6ef70fabf37a908ae0b72fb59
MD5 b1f529bb220ebab96684ec4d82207883
BLAKE2b-256 95beec944c5fbdbaba8a63054fd88b2ebf124b02a509796387d2949910c31ebb

See more details on using hashes here.

File details

Details for the file foxreg-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: foxreg-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.19

File hashes

Hashes for foxreg-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0b8f28c23c2952d4948108229c96b195b9c76f3bbd0fc30bb86d667d3a231c36
MD5 dda6da900fa7206d9ac169ec0f2fcb3e
BLAKE2b-256 3437fae4ae78a801703e424c50c72a45400597944bd93567aa4e8e88c986ab78

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