Skip to main content

Container class for single-cell experiments

Project description

Project generated with PyScaffold PyPI-Server Unit tests

SingleCellExperiment

This package provides container class to represent single-cell experimental data as 2-dimensional matrices. In these matrices, the rows typically denote features or genomic regions of interest, while columns represent cells. In addition, a SingleCellExperiment (SCE) object may contain low-dimensionality embeddings, alternative experiments performed on same sample or set of cells. Follows Bioconductor's SingleCellExperiment.

Install

To get started, install the package from PyPI

pip install singlecellexperiment

Usage

The SingleCellExperiment extends RangeSummarizedExperiment and contains additional attributes:

  • reduced_dims: Slot for low-dimensionality embeddings for each cell.
  • alternative_experiments: Manages multi-modal experiments performed on the same sample or set of cells.
  • row_pairs or column_pairs: Stores relationships between features or cells.

Readers are available to parse h5ad or AnnData objects to SCE:

import singlecellexperiment

sce = singlecellexperiment.read_h5ad("tests/data/adata.h5ad")
## output
class: SingleCellExperiment
dimensions: (20, 30)
assays(3): ['array', 'sparse', 'X']
row_data columns(5): ['var_cat', 'cat_ordered', 'int64', 'float64', 'uint8']
row_names(0):
column_data columns(5): ['obs_cat', 'cat_ordered', 'int64', 'float64', 'uint8']
column_names(0):
main_experiment_name:
reduced_dims(0): []
alternative_experiments(0): []
row_pairs(0): []
column_pairs(0): []
metadata(2): O_recarray nested

OR construct one from scratch

from singlecellexperiment import SingleCellExperiment

tse = SingleCellExperiment(
    assays={"counts": counts}, row_data=df_gr, col_data=col_data,
    reduced_dims={"tsne": ..., "umap": ...}, alternative_experiments={"atac": ...}
)

Since SingleCellExperiment extends RangeSummarizedExperiment, most methods especially slicing and accessors are applicable here. Checkout the documentation for more info.

Note

This project has been set up using PyScaffold 4.5. For details and usage information on PyScaffold see https://pyscaffold.org/.

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

singlecellexperiment-0.5.3.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

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

SingleCellExperiment-0.5.3-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file singlecellexperiment-0.5.3.tar.gz.

File metadata

  • Download URL: singlecellexperiment-0.5.3.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for singlecellexperiment-0.5.3.tar.gz
Algorithm Hash digest
SHA256 25d297eaf6f70453c3e7a5cc3f11f84dd0426b1d0ad67200d0dcd53835f340a4
MD5 df8417f611846d44fa9295e86dad950b
BLAKE2b-256 c644973acfed48e0ca8e4ea74f3a94aeb62db2e899a0a9970601579e9a58e688

See more details on using hashes here.

File details

Details for the file SingleCellExperiment-0.5.3-py3-none-any.whl.

File metadata

File hashes

Hashes for SingleCellExperiment-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 243734e1d6bee9b94b78a77fc3b2e24192b5695d264efe2cdca74ecfd148b2f8
MD5 58e5db06eef3ff3cc084b32f61ed1a28
BLAKE2b-256 0b168620468d525bef1e710048f598f9b3a5a62b32c772ff25aa7102d73baa16

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