Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ToryDeng committed Apr 27, 2024
1 parent e28cc35 commit e368efa
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 7 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# LEGEND: An integrative algorithm for identifying co-expressed and cofunctional genes in multimodal transcriptomic sequencing data
<img
src="docs/assets/img/logo.png"
class="dark-light" align="right" width="70" alt="image"
/>

We present a novel method called mu**L**timodal co-**E**xpressed **GE**nes fin**D**er (LEGEND) that performs integrated gene clustering on scRNA-seq and SRT data to identify co-expressed genes at both the cell type and tissue domain levels. LEGEND performs a hierarchical gene clustering with the aim of maximizing intra-cluster redundancy and inter-cluster complementarity.
# LEGEND: Identifying Co-expressed Genes in Multimodal Transcriptomic Sequencing Data

We present a novel method called mu**L**timodal co-**E**xpressed **GEN**es fin**D**er (LEGEND) that performs integrated gene clustering on scRNA-seq and SRT data to identify co-expressed genes at both the cell type and tissue domain levels. LEGEND performs a hierarchical gene clustering with the aim of maximizing intra-cluster redundancy and inter-cluster complementarity.

![image](docs/assets/img/workflow.png)

Expand Down Expand Up @@ -28,7 +33,7 @@ You can download the package from GitHub and install it locally:
```shell
git clone https://github.com/ToryDeng/LEGEND.git
cd LEGEND/
pip install dist/LEGEND-0.1.0-py3-none-any.whl
pip install dist/LEGEND-0.1.1-py3-none-any.whl
```

## Getting started
Expand Down
Binary file not shown.
Binary file added dist/LEGEND-0.1.1.tar.gz
Binary file not shown.
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ toc: true

## Introduction

Exploring co-expressed genes is essential for revealing biologically co-functional genes. However, existing methods for this purpose rely solely on sc/snRNA-seq or spatially-resolved transcriptomic (SRT) data, leading to weaker co-functionality among identified genes. We present `LEGEND` (mu**L**timodal co-**E**xpressed **GE**nes fin**D**er), a novel method that performs integrated gene clustering on sc/snRNA-seq and SRT data for identifying genes co-expressed at both the cell type and tissue domain levels.
Exploring co-expressed genes is essential for revealing biologically co-functional genes. However, existing methods for this purpose rely solely on sc/snRNA-seq or spatially-resolved transcriptomic (SRT) data, leading to weaker co-functionality among identified genes. We present `LEGEND` (mu**L**timodal co-**E**xpressed **GEN**es fin**D**er), a novel method that performs integrated gene clustering on sc/snRNA-seq and SRT data for identifying genes co-expressed at both the cell type and tissue domain levels.


<img src="assets/img/workflow.png" width="100%">
Expand Down Expand Up @@ -49,7 +49,7 @@ git clone https://github.com/ToryDeng/LEGEND.git
# Navigate to the LEGEND directory
cd LEGEND/
# Install the package using pip
pip install dist/LEGEND-0.1.0-py3-none-any.whl
pip install dist/LEGEND-0.1.1-py3-none-any.whl
```

You can verify that `LEGEND` has been successfully installed by executing:
Expand All @@ -62,7 +62,7 @@ And if everything works fine, you will get output like:

```text
Name: LEGEND
Version: 0.1.0
Version: 0.1.1
Summary: An integrative algorithm for identifying co-expressed and cofunctional genes in multimodal transcriptomic sequencing data
Home-page: https://github.com/ToryDeng/LEGEND
Author: Tao Deng
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

setup(
name="LEGEND",
version="0.1.0",
version="0.1.1",
description="An integrative algorithm for identifying co-expressed and cofunctional genes in "
"multimodal transcriptomic sequencing data",
long_description=LONG_DESCRIPTION,
Expand Down

0 comments on commit e368efa

Please sign in to comment.