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.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.6.3-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for singlecellexperiment-0.6.3.tar.gz
Algorithm Hash digest
SHA256 e1365e17222af1d0c0116da30e353eb3e46d8d01b218e9efbf4e3a7a1a59528f
MD5 9ec3b3822e0e40ef1eac5dd91449dd3c
BLAKE2b-256 616d45a2df6492d68edc03a476efda6c5abbab3001f95fc848c0bea77d877597

See more details on using hashes here.

Provenance

The following attestation bundles were made for singlecellexperiment-0.6.3.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.3-py3-none-any.whl.

File metadata

File hashes

Hashes for singlecellexperiment-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3c0a9e24c1caa70cc7f68a3ce0218f64baef20950cad86c4e05bb0d26ab33f3a
MD5 f25d1228be50b4b750043ac93427bb56
BLAKE2b-256 284488a589a6a0df101b95ed3bfea6b97201ace6ef7ad7b3c7cbd0d44f33a898

See more details on using hashes here.

Provenance

The following attestation bundles were made for singlecellexperiment-0.6.3-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