Skip to main content

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.

Metadata

Release files for scCellFie 0.6.3

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

Source distribution (sdist)

Source distribution for scCellFie 0.6.3
File Size Uploaded
sccellfie-0.6.3.tar.gz 169.4 kB Details

Built distribution (wheel)

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

Total release size: 379.9 kB

Release files / sccellfie-0.6.3.tar.gz

Download URL sccellfie-0.6.3.tar.gz
Size 169.4 kB
Tags Source
SHA-256 checksum
How to use checksums
45426544231e499b4fd689837d6edd1384df250c90710597ac830c236b375c37
BLAKE2b-256 checksum
How to use checksums
0f305ced013e7a4fad603113d68715a9970dc803ed89af01386cebef07f196b1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / sccellfie-0.6.3-py3-none-any.whl

Download URL sccellfie-0.6.3-py3-none-any.whl
Size 210.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
825d3968864c408294c11ded42551a24cd494aa0897691e85865ce8cd096e750
BLAKE2b-256 checksum
How to use checksums
f537f57164dc16b77c76e1cbf6570d7b493f92d957f79c93d5ee6b767f466339
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release history Release notifications | RSS feed

This release

0.6.3 This release

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.8

2 release files

0.4.7

2 release files

0.4.6

2 release files

0.4.5

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.14

2 release files

0.1.10

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

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