Skip to main content

A comprehensive tool for gene regulatory network modeling.

Project description

# grnm

This project aims to analyze gene regulatory networks (GRNs) by integrating archR processed gene score data and single-cell RNA sequencing (scRNA) data. The workflow consists of the following steps:

## Step 1: Preprocessing and Data Integration

After preprocessing and collecting the necessary files, the gene score data obtained from archR processing is combined with scRNA data. The combined data is then subjected to Principal Component Analysis (PCA) for dimensionality reduction. The number of genes is denoted as M, and the PCA dimensions are denoted as d. This results in an M * d1 matrix.

## Step 2: Deep Learning-based Dimensionality Reduction

The M * d1 matrix obtained from Step 1 is further processed using a deep learning model for dimensionality reduction. The resulting matrix has dimensions M * d2 in the latent space. Subsequently, Uniform Manifold Approximation and Projection (UMAP) algorithm is applied for additional dimensionality reduction, resulting in an M * 2 matrix. These coordinates serve as the basis for plotting each gene.

## Step 3: Clustering Using Louvain Algorithm

The TF-target regulatory relationships extracted from the Pando processed files are used to construct an adjacency matrix. The Louvain algorithm is then applied to perform clustering on the genes. This step allows for the identification of different modules to which each gene belongs.

## Step 4: Visualization

A series of functions are provided to generate various plots, encapsulating different attributes of the formed GRN. These functions facilitate easy visualization of the network’s properties.

By following these steps and utilizing the provided functions, users can gain insights into the characteristics and dynamics of the gene regulatory networks under study.

## Pre-requisites

Before you begin, ensure you have met the following requirements:

  • Operating System: Windows 10, Ubuntu 20.04, macOS Mojave or later.

  • Dependencies: Ensure you have pip installed on your system.

## Installation Recommendations

To ensure a smooth installation and operation of our software, please follow these recommendations:

### Environment Setup

  • Python Version: It is recommended to use Python 3.9 for optimal compatibility with our software. If you do not have Python 3.9 installed, you can download it from the [official Python website](https://www.python.org/downloads/).

### Network Stability

  • Internet Connection: Make sure you have a stable internet connection before starting the installation process. This is crucial for downloading necessary packages and dependencies without interruption.

### Pre-installing Dependencies

  • Deep Graph Library (DGL): Our software relies on the Deep Graph Library (DGL) for efficient graph operations. To minimize installation issues, we recommend installing DGL before proceeding with the installation of our software.

    You can install DGL by running the following command:

    `bash pip install dgl `

  • grnm:You can install drnm by running the following command: `bash pip install grnm ` ## example

  • [example Notebook](notebooks/example.ipynb)

Project details


Release history Release notifications | RSS feed

This version

0.6

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

grnm-0.6.tar.gz (35.8 MB view details)

Uploaded Source

Built Distribution

grnm-0.6-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

Details for the file grnm-0.6.tar.gz.

File metadata

  • Download URL: grnm-0.6.tar.gz
  • Upload date:
  • Size: 35.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.16

File hashes

Hashes for grnm-0.6.tar.gz
Algorithm Hash digest
SHA256 9db54fb63ba10f83db496365aa017cc25bae336a74ea951e7ba19d628be7e9ff
MD5 8576a836af9c6bd54d8c30046bfddf2c
BLAKE2b-256 a760587c72625e0cab247dfe5d0b2781a1a8c83b49d3af14ca629f56d9cb7cdc

See more details on using hashes here.

File details

Details for the file grnm-0.6-py3-none-any.whl.

File metadata

  • Download URL: grnm-0.6-py3-none-any.whl
  • Upload date:
  • Size: 20.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.16

File hashes

Hashes for grnm-0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 816125fa5346ce1bda4edafe9543b5feee7b39e905dfdf20242a7cf250e4645e
MD5 530405c03ad359d5c3253956515a536d
BLAKE2b-256 91691c5b6fbe76142ff4d28c877e197a283ba81d1a05c498fbf8984d77f48afc

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