Skip to main content

EEISP

EEISP identifies gene pairs that are codependent and mutually exclusive from single-cell RNA-seq data.

0. Changelog

See Changelog

1. Installation

pip3 install -U eeisp

2. Usage

EEISP takes a read count matrix as an input, in which rows and columns represent genes and cells, respectively. A gzipped file (.gz) is also acceptable.

  1. (Optional) Convert CellRanger output to an input matrix (require R and Seurat library)

      datadir="outs/filtered_feature_bc_matrix/"
      matrix="matrix.txt"
      R -e "library(Seurat); so <- Read10X('$datadir'); write.table(so, '$matrix', quote=F, sep=',', col.names=T)"
    
  2. eeisp calculates the CDI and EEI scores for all gene pairs. The output contains lists of gene pairs that have CDI or EEI values above the specified threshold and the tables of degree distribution.

      usage: eeisp [-h] [--threCDI THRECDI] [--threEEI THREEEI] [--tsv] [--gpu] [-p THREADS] [-v] matrix output
    
      positional arguments:
        matrix                Input matrix
        output                Output prefix
    
      optional arguments:
        -h, --help            show this help message and exit
        --threCDI THRECDI     Threshold for CDI (default: 20.0)
        --threEEI THREEEI     Threshold for EEI (default: 10.0)
        --tsv                 Specify when the input file is tab-delimited (.tsv)
        --gpu                 GPU mode
        -p THREADS, --threads THREADS  number of threads (default: 2)
        -v, --version         show program's version number and exit
    
  3. eeisp_add_genename_from_geneid add Gene Names (Symbols) to the output files of eeisp.

     usage: eeisp_add_genename_from_geneid [-h] [--i_id I_ID] [--i_name I_NAME] input output genelist
    
     positional arguments:
       input            Input matrix
       output           Output prefix
       genelist         Gene list
    
     optional arguments:
       -h, --help       show this help message and exit
       --i_id I_ID      column number of gene id (default: 0)
       --i_name I_NAME  column number of gene name (default: 1)
    

3. Tutorial

The sample data is included in sample directory.

  • data.txt: the input matrix of scRNA-seq data.
  • genelidlist.txt: the gene list for eeisp_add_genename_from_geneid.
eeisp data.txt Sample --threCDI 0.5 --threEEI 0.5 -p 8

This command outputs gene pair lists that have CDI>0.5 or EEI>0.5. -p 8 means 8 CPUs are used.

(Note: Since GPU computation covers a part of eeisp, it is better to use multiple CPUs even in --gpu mode for the fast computation.)

Output files are:

   Sample_CDI_score_data_thre0.5.txt            # A list of gene pairs with CDI score.
   Sample_CDI_degree_distribution_thre0.5.csv   # A table of the number of CDI degree and genes.
   Sample_EEI_score_data_thre0.5.txt            # A list of gene pairs with EEI scores.
   Sample_EEI_degree_distribution_thre0.5.csv   # A table of the number of EEI degree and genes.

The output files might include gene ids only.

   $ head Sample_CDI_score_data_thre0.5.txt
   2       7       ESG000003       ESG000008       0.96384320244841
   0       1       ESG000001       ESG000002       0.6852891560232545
   0       6       ESG000001       ESG000007       0.6852891560232545
   7       8       ESG000008       ESG000009       0.6852891560232545
   3       9       ESG000004       ESG000010       0.6469554204484568
   4       6       ESG100005       ESG000007       0.5258703930217091

If you want to add gene names (Symbols), use eeisp_add_genename_from_geneid with geneidlist.txt, which contains the pairs of gene ids and names.

 eeisp_add_genename_from_geneid \
     Sample_CDI_score_data_thre0.5.txt \
     Sample_CDI_score_data_thre0.5.addgenename.txt \
     geneidlist.txt
 eeisp_add_genename_from_geneid \
     Sample_EEI_score_data_thre0.5.txt \
     Sample_EEI_score_data_thre0.5.addgenename.txt \
     geneidlist.txt

The output files include gene names.

   $ head Sample_CDI_score_data_thre0.5.addgenename.txt
   2       7       ESG000003       ESG000008       OR4F5   FO538757.3      0.96384320244841
   0       1       ESG000001       ESG000002       RP11-34P13.3    FAM138A 0.6852891560232545
   0       6       ESG000001       ESG000007       RP11-34P13.3    RP11-34P13.9    0.6852891560232545
   7       8       ESG000008       ESG000009       FO538757.3      FO538757.2      0.6852891560232545
   3       9       ESG000004       ESG000010       RP11-34P13.7    AP006222.2      0.6469554204484568
   4       6       ESG100005       ESG000007       RP11-34P13.8    RP11-34P13.9    0.5258703930217091

4. Reference

Nakajima N., Hayashi T., Fujiki K., Shirahige K., Akiyama T., Akutsu T. and Nakato R., Codependency and mutual exclusivity for gene community detection from sparse single-cell transcriptome data, Nucleic Acids Research, 2021.

Release files for eeisp 0.6.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for eeisp 0.6.4
File Size Uploaded
eeisp-0.6.4.tar.gz 24.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for eeisp 0.6.4
File Interpreter ABI Platform
eeisp-0.6.4-py3-none-any.whl Python 3 none any Details

Total release size: 47.6 kB

Release files / eeisp-0.6.4.tar.gz

Download URL eeisp-0.6.4.tar.gz
Size 24.1 kB
Tags Source
SHA-256 checksum
How to use checksums
bfc9f01dab111c8cb8f8ed396905198bbeca0bd2f098725bdc69ed8d64af32f4
BLAKE2b-256 checksum
How to use checksums
245871fd13ac421550b987fce9ecd85e4ed4d4aea6a1af14175398b85991e466
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.13

Release files / eeisp-0.6.4-py3-none-any.whl

Download URL eeisp-0.6.4-py3-none-any.whl
Size 23.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ab5e39192bf892b6aaaec0614fd7c48976ad77b2ce5bbf16f12b76a6cf24a54e
BLAKE2b-256 checksum
How to use checksums
bcebaee69d3c62233c7f7b84106943c375da59de6d52d46d14b03e1dc2005155
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.13

Release history Release notifications | RSS feed

This release

0.6.4 This release

2 release files

0.6.3

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

1 release file

0.5.0

1 release file

0.4.1

1 release file

0.4.0

1 release file

0.3.0

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page