Unit tests

SummarizedExperiment

This package provides containers to represent genomic experimental data as 2-dimensional matrices, follows Bioconductor's SummarizedExperiment. In these matrices, the rows typically denote features or genomic regions of interest, while columns represent samples or cells.

The package currently includes representations for both SummarizedExperiment and RangedSummarizedExperiment. A distinction lies in the fact RangedSummarizedExperiment object provides an additional slot to store genomic regions for each feature and is expected to be GenomicRanges (more here).

Install

To get started, Install the package from PyPI,

pip install summarizedexperiment

Usage

A SummarizedExperiment contains three key attributes,

assays: A dictionary of matrices with assay names as keys, e.g. counts, logcounts etc.
row_data: Feature information e.g. genes, transcripts, exons, etc.
column_data: Sample information about the columns of the matrices.

First lets mock feature and sample data:

from random import random
import pandas as pd
import numpy as np
from biocframe import BiocFrame

nrows = 200
ncols = 6
counts = np.random.rand(nrows, ncols)
row_data = BiocFrame(
    {
        "seqnames": [
            "chr1",
            "chr2",
            "chr2",
            "chr2",
            "chr1",
            "chr1",
            "chr3",
            "chr3",
            "chr3",
            "chr3",
        ]
        * 20,
        "starts": range(100, 300),
        "ends": range(110, 310),
        "strand": ["-", "+", "+", "*", "*", "+", "+", "+", "-", "-"] * 20,
        "score": range(0, 200),
        "GC": [random() for _ in range(10)] * 20,
    }
)

col_data = pd.DataFrame(
    {
        "treatment": ["ChIP", "Input"] * 3,
    }
)

To create a SummarizedExperiment,

from summarizedexperiment import SummarizedExperiment

tse = SummarizedExperiment(
    assays={"counts": counts}, row_data=row_data, column_data=col_data,
    metadata={"seq_platform": "Illumina NovaSeq 6000"},
)

## output
class: SummarizedExperiment
dimensions: (200, 6)
assays(1): ['counts']
row_data columns(6): ['seqnames', 'starts', 'ends', 'strand', 'score', 'GC']
row_names(0):
column_data columns(1): ['treatment']
column_names(0):
metadata(1): seq_platform

To create a RangedSummarizedExperiment

from summarizedexperiment import RangedSummarizedExperiment
from genomicranges import GenomicRanges

trse = RangedSummarizedExperiment(
    assays={"counts": counts}, row_data=row_data,
    row_ranges=GenomicRanges.from_pandas(row_data.to_pandas()), column_data=col_data
)

## output
class: RangedSummarizedExperiment
dimensions: (200, 6)
assays(1): ['counts']
row_data columns(6): ['seqnames', 'starts', 'ends', 'strand', 'score', 'GC']
row_names(0):
column_data columns(1): ['treatment']
column_names(0):
metadata(0):

For more examples, checkout the documentation.

Note

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

Release files for summarizedexperiment 0.5.2

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

Source distribution (sdist)

Source distribution for summarizedexperiment 0.5.2
File	Size	Uploaded
summarizedexperiment-0.5.2.tar.gz	1.0 MB	Jan 2, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for summarizedexperiment 0.5.2
File	Interpreter	ABI	Platform	Reset
SummarizedExperiment-0.5.2-py3-none-any.whl 22.1 kB Jan 2, 2025	Python 3	none	any	Details

Total release size: 1.0 MB

Release files / summarizedexperiment-0.5.2.tar.gz

Download URL	summarizedexperiment-0.5.2.tar.gz
Size	1.0 MB
Tags	Source
SHA-256 checksum How to use checksums	`343a850dca36f77ce73ee24eed2714e5defca9d1b2e3a7050af6262d4c03b3b5`
BLAKE2b-256 checksum How to use checksums	`142bfb00c8e394dfae9145cd2f47c9ca5d03893cb53caadf9ea0a1b7035360ef`
Upload date	Jan 2, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.12.7`

Release files / SummarizedExperiment-0.5.2-py3-none-any.whl

Download URL	SummarizedExperiment-0.5.2-py3-none-any.whl
Size	22.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`11100b6709b4217d78b321b5516674ae056b74d5e823bbc0f0b23b49af2fd1fc`
BLAKE2b-256 checksum How to use checksums	`56243d0d639bd235c7fdba4947d6c02811af5433a92f4f882d9e92556f7641be`
Upload date	Jan 2, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.12.7`