Skip to main content

A tool for inferring metabolic activities from single-cell and spatial transcriptomics

Project description

PYPI test-sccellfie Codecov Downloads License: MIT

Metabolic activity from single-cell and spatial transcriptomics with scCellFie

scCellFie is a Python-based tool for analyzing metabolic activity at different resolutions, developed at the Vento Lab. It efficiently processes both single-cell and spatial data to predict metabolic task activities. While its prediction strategy is inspired by CellFie, a tool from the Lewis Lab originally developed in MATLAB for bulk and small single-cell datasets, scCellFie includes a series of improvements and new analyses, such as marker selection, differential analysis, and cell-cell communication inference.

Logo

Features

  • Single cell and spatial data analysis: Inference of metabolic activity per single cell or spatial spot.

  • Speed: Runs fast and memory efficiently, scaling up to large datasets. ~100k single cells can be analyzed in ~8 min.

  • Downstream analyses: From marker selection of relevant metabolic tasks to integration with inference of cell-cell communication.

  • User-friendly: Python-based for easier use and integration into existing workflows, including Jupyter Notebooks.

  • Scanpy compatibility: Fully integrated with Scanpy, the popular single-cell analysis toolkit.

  • Organisms: Metabolic database and analysis available for human and mouse.

Documentation and Tutorials

Installation

To create a new conda environment (optional):

# Create a new conda environment
conda create -n sccellfie -y python=3.10

# Activate the environment
conda activate sccellfie

To install scCellFie, use pip:

pip install sccellfie

Quick Start

A quick example of how to use scCellFie with a single-cell dataset to infer metabolic activities and export them:

import sccellfie
import scanpy as sc

# Load the dataset
adata = sc.read(filename='./data/HECA-Subset.h5ad',
                backup_url='https://zenodo.org/records/15072628/files/HECA-Subset.h5ad')

# Run one-command scCellFie pipeline
results = sccellfie.run_sccellfie_pipeline(adata,
                                           organism='human',
                                           sccellfie_data_folder=None,
                                           n_counts_col='n_counts',
                                           process_by_group=False,
                                           groupby=None,
                                           neighbors_key='neighbors',
                                           n_neighbors=10,
                                           batch_key='sample',
                                           threshold_key='sccellfie_threshold',
                                           smooth_cells=True,
                                           alpha=0.33,
                                           chunk_size=5000,
                                           disable_pbar=False,
                                           save_folder=None,
                                           save_filename=None
                                          )

# Save adata objects containing single-cell/spatial predictions
sccellfie.io.save_adata(adata=results['adata'],
                        output_directory='/folder/path/',
                        filename='sccellfie_results'
                        )

# Summarize results in a cell-group level for the Metabolic Task Visualizer
report = sccellfie.reports.generate_report_from_adata(results['adata'].metabolic_tasks,
                                                      group_by=cell_group,
                                                      tissue_column='condition',
                                                      feature_name='metabolic_task'
                                                      )

# Export files to a specific folder.
sccellfie.io.save_result_summary(results_dict=report, output_directory='/folder/path/')

# Melted.csv and Min_max.csv are input files for the Metabolic Task Visualizer

To access metabolic activities, we need to inspect results['adata']:

  • The processed single-cell data is located in the AnnData object results['adata'].

  • The reaction activities for each cell are located in the AnnData object results['adata'].reactions.

  • The metabolic task activities for each cell are located in the AnnData object results['adata'].metabolic_tasks.

In particular:

  • results['adata']: contains gene expression in .X.

  • results['adata'].layers['gene_scores']: contains gene scores as in the original CellFie paper.

  • results['adata'].uns['Rxn-Max-Genes']: contains determinant genes for each reaction per cell.

  • results['adata'].reactions: contains reaction scores in .X so every scanpy function can be used on this object to visualize or compare values.

  • results['adata'].metabolic_tasks: contains metabolic task scores in .X so every scanpy function can be used on this object to visualize or compare values.

Other keys in the results dictionary are associated with the scCellFie database and are already filtered for the elements present in the dataset ('gpr_rules', 'task_by_gene', 'rxn_by_gene', 'task_by_rxn', 'rxn_info', 'task_info', 'thresholds', 'organism').

How to Cite

Please consider citing our work if you find scCellFie useful:

Acknowledgments

This tool is inspired by the original CellFie tool developed by the Lewis Lab. Please consider citing their work if you find our tool useful:

Contributing

We welcome contributions! Feel free to add requests in the issues section or directly contribute with a pull request.

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

sccellfie-0.5.0.tar.gz (120.1 kB view details)

Uploaded Source

Built Distribution

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

sccellfie-0.5.0-py3-none-any.whl (154.7 kB view details)

Uploaded Python 3

File details

Details for the file sccellfie-0.5.0.tar.gz.

File metadata

  • Download URL: sccellfie-0.5.0.tar.gz
  • Upload date:
  • Size: 120.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for sccellfie-0.5.0.tar.gz
Algorithm Hash digest
SHA256 fcbe78997b30177c7a2c280f216cf7726f5bf175e375a35295c2acb279f2aca7
MD5 f7a97fc9f33bb8100bc0667c232b6492
BLAKE2b-256 a37d3b17afea04cdab59033e3990500aa306df4ecc0bd6222f86349ce3479ff2

See more details on using hashes here.

File details

Details for the file sccellfie-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: sccellfie-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 154.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for sccellfie-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5ccee11a34e6a52ffe58c0a9508571d0447e800ad0c519501bbcea3a9c36b57b
MD5 402eb803f453020dfa1f7fedef3b804b
BLAKE2b-256 6a19dcf9d5c15f7088bd52312c980aaf782a4fa1fec9951545cc5ace48ebfdf2

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