Skip to main content

A Python package for performing gene set enrichment analysis on single cell clusters.

Project description

NOTE: The method for this module is still under active development, not finalized, and should not be used.

scGSEA

Description: scGSEA is an extension of ssGSEA designed to improve the assessment of pathway activity in single-cell data by addressing sparsity and ensuring stable enrichment scoring. This module is intended to be used subsequent to Seurat.Clustering module and the user can supply the Seurat RDS file.

Authors: John Jun; UCSD - Mesirov Lab, UCSD

Contact: Forum Link.

Summary

scGSEA is an extension of ssGSEA tailored for single-cell data analysis. It addresses the challenges of sparsity and unreliable enrichment scoring by employing specialized normalization methods and scoring metrics. By utilizing scGSEA, scientists can explore and interpret pathway activity and functional alterations within heterogeneous populations of cells, thereby advancing our understanding of complex biological systems.

Parameters

Name Description Default Value
input_file * File to be read in RDS format
chip_file Chip file used for conversion to gene symbols
gene_set_database_file * Gene set data in GMT format
output_file_name * The basename to use for output file scGSEA_scores

* required

Input Files

  1. input_file This is the Seurat RDS file from the Seurat.Clustering module.
  2. chip_file
    This parameter’s drop-down allows you to select CHIP files from the Molecular Signatures Database (MSigDB) on the GSEA website. This drop-down provides access to only the most current version of MSigDB. You can also upload your own gene set file(s) in CHIP format.
  3. gene_set_database_file
    • This parameter’s drop-down allows you to select gene sets from the Molecular Signatures Database (MSigDB) on the GSEA website. This drop-down provides access to only the most current version of MSigDB. You can also upload your own gene set file(s) in GMT format.
    • If you want to use files from an earlier version of MSigDB you will need to download them from the archived releases on the website.
  4. output_file_name
    The prefix used for the name of the output GCT and CSV file. If unspecified, output prefix will be set to scGSEA_scores. The output CSV and GCT files will contain the projection of input dataset onto a space of gene set enrichments scores.
  5. cluster_data_label
    The name of the metadata label within the input Seurat object. This label will be used to access the annotations utilized for aggregating cells. The default value for this parameter is seurat_clusters, which is the metadata label for cluster annotations generated upon running Seurat.Clustering module. Use the default value when using the RDS file generated from the Seurat.Clustering module.

Output Files

  1. <output_file_name>.csv
    This is a gene set by cell cluster data consisted of scGSEA scores.
  2. <output_file_name>.gct
    This is a gene set by cell cluster data consisted of scGSEA scores. The HeatmapViewer module can accept this file as input for generating heatmap visualizations.
  3. cluster_expression.csv
    This is a gene by cell cluster data consisted of normalized gene expression level.
  4. stdout.txt
    This is standard output from the script.

For more details, please refer to the full documentation.

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

sc_ssgsea-1.0.0.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

sc_ssGSEA-1.0.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file sc_ssgsea-1.0.0.tar.gz.

File metadata

  • Download URL: sc_ssgsea-1.0.0.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for sc_ssgsea-1.0.0.tar.gz
Algorithm Hash digest
SHA256 fef667ace18210497a1167d3b2d7e294205ec7af33fbdc8a790b1e817314b841
MD5 097f213dbe5df311a0ac2fe723a174a5
BLAKE2b-256 699d96da7719a15754daa08c4061cc1f76e55eb0a1b246b33ffcbef6b5a707f4

See more details on using hashes here.

File details

Details for the file sc_ssGSEA-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: sc_ssGSEA-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for sc_ssGSEA-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 80c5988e636279b89086f130a386bcfe37042bee2fe75e64bef3244789aba662
MD5 77ab960d88b4576d781f0b80821c71ee
BLAKE2b-256 44476d5c1e85f5b118610b14d8fefc77907eb36517abf0ed74120f92f84c51bb

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