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 RangedSummarizedExperiment 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 RangedSummarizedExperiment, most methods especially slicing and accessors are inherited from the parent classes. 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.6.0.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.6.0-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: singlecellexperiment-0.6.0.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for singlecellexperiment-0.6.0.tar.gz
Algorithm Hash digest
SHA256 a15fe257e4bf6ed5883bed6cc0b0de939e853d8dc1326f821c7cd978e31a4b29
MD5 262338f0489133872458fac09e8c789e
BLAKE2b-256 c49870a9ed0ed7a1e1c877676f5ab1f12d8f016d183597327b778fe34095f8cc

See more details on using hashes here.

Provenance

The following attestation bundles were made for singlecellexperiment-0.6.0.tar.gz:

Publisher: publish-pypi.yml on BiocPy/SingleCellExperiment

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file singlecellexperiment-0.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for singlecellexperiment-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 73fec73e87c17b2da24a169f8c29b6022f3dd73bfdbef5a08d1abe80f4decfb3
MD5 c15df3b4ee4db2b9b6fc183aaf8eac96
BLAKE2b-256 87e1243f96f1fea689f14afed3f7a383e9f33244bc98883a176adfab0ca7a00f

See more details on using hashes here.

Provenance

The following attestation bundles were made for singlecellexperiment-0.6.0-py3-none-any.whl:

Publisher: publish-pypi.yml on BiocPy/SingleCellExperiment

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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