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

Uploaded Python 3

File details

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

File metadata

  • Download URL: singlecellexperiment-0.5.1.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.1.tar.gz
Algorithm Hash digest
SHA256 d6b512ed6035e95b3f144f40cdf47ef079f56d3bb2c705a7e9fcab28006f6589
MD5 b63f4fea034eca68c589c416edd83157
BLAKE2b-256 39cb14f01ac246e32ce9a27eb21fec8de25f69e119e4a63ab0fc3f34b66a8d62

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for SingleCellExperiment-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 21d2c6d32be4d73375bc3d8d988869ba8857fc6a16c46cb2b9fce4d008dc80bb
MD5 74df8f8754c3d7543531adad0d5b6017
BLAKE2b-256 907f79313e1ea239e168d51d05990b4c9e3b10b78b0468a453f5fcddc2fa3b93

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