Skip to content
cccskills
FreePublished on GitHub

bioconductor-spatialexperiment

Defines an S4 class for storing data from spatial -omics experiments. The class extends SingleCellExperiment to support storage and retrieval of additional information from spot-based and molecule-based platforms, including spatial coordina

The English summary is being prepared. Showing the original description.

See how to install

Files included (1)

  • SKILL.md5.5 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

SpatialExperiment

Dependencies & Environment

Package-intrinsic requirements from the Bioconductor landing page — reproduce in any R environment.

  • Version: 1.22.0 · Bioconductor: 3.23 · R: ≥ 4.6
  • Depends: SingleCellExperiment
  • Imports: rjson, magick, S4Vectors, SummarizedExperiment, BiocGenerics, BiocFileCache
  • Install: BiocManager::install("SpatialExperiment")

When to Use

  • Spot-Based Spatial Transcriptomics: Representing and manipulating data from spot-based spatial transcriptomics platforms (e.g., 10x Genomics Visium) containing gene expression, spatial coordinates, and histology images using SpatialExperiment() and imgData().
  • Molecule-Resolved Spatial Data: Storing and querying molecule-resolved spatial data (e.g., seqFISH) where exact X-Y coordinates of individual transcripts are recorded, using splitAsBumpyMatrix() and the molecules() accessor.
  • Image Transformations: Applying basic image transformations like rotation and mirroring to spatial images using rotateImg() and mirrorImg().

When NOT to Use

  • For standard single-cell RNA-seq data lacking spatial coordinates, use SingleCellExperiment instead because the spatial-specific slots like spatialCoords and imgData will remain empty and add unnecessary overhead.
  • For pure image processing without transcriptomics, use other imaging tools because SpatialExperiment is designed to link assays (like counts) with spatial metadata.

Data Requirements

  • Assays: A count matrix (e.g., counts) representing gene expression across spatial locations.
  • Spatial Coordinates: A numeric matrix or DataFrame of coordinates (e.g., x and y) for each spot or cell.
  • Image Data (Optional): Images stored as SpatialImage objects within an imgData DataFrame.

Key Parameters

  • assays (required): A list of matrices containing expression data (e.g., counts).
  • spatialCoords (optional): A numeric matrix containing spatial coordinates.
  • spatialCoordsNames (optional): A character vector specifying which colData fields correspond to spatial coordinates.
  • imgData (optional): A DataFrame containing image metadata and SpatialImage objects.
  • colData (optional): A DataFrame containing spot- or cell-level metadata.
  • sample_id (default "sample_01"): A character string specifying the sample identifier.

Best Practices

  • Use spatialCoords() and imgData() accessor functions instead of directly manipulating internal slots to maintain object integrity.
  • For 10x Genomics Visium data, use TENxVisiumList() and import() from the VisiumIO package to automatically load outputs from Space Ranger.
  • Make sample identifiers unique prior to combining objects with cbind() to avoid automatic index appending.

Common Pitfalls

  • Duplicated sample IDs during replacement: Attempting to replace sample_ids with non-unique values returns an error; fix this by ensuring replacement IDs map uniquely to existing ones.
  • Loss of sample IDs: Attempting to remove sample_id by setting it to NULL fails because it is a protected field; fix this by retaining the sample_id or replacing it with valid unique strings.
  • Conflicting spatial coordinates: Supplying both spatialCoords and spatialCoordsNames causes spatialCoordsNames to be ignored; fix this by setting either to NULL to suppress the warning message.

Alternatives

  • SingleCellExperiment: The parent class, which can store coordinates in colData but lacks dedicated spatialCoords and imgData slots.
  • Seurat: Another framework for single-cell and spatial data analysis.
  • Giotto: An independent R package for spatial transcriptomics.

Citations

  • Righelli, D., et al. (2022). SpatialExperiment: infrastructure for spatially resolved transcriptomics data in Bioconductor. Bioinformatics, 38(11), 3128-3130.

References

<!-- biomate-cta -->

Run this on BioMate

This skill is the knowledge layer — when, why, and how to use spatialexperiment. To run this analysis on your own data with managed compute, automated QC, and reproducible outputs, use BioMate — free to start.

▶ Open spatialexperiment on BioMate →

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

The package contains functions for exploratory oligonucleotide array analysis. The dependence on tkWidgets only concerns few convenience functions. 'affy' is fully functional without it.

The English summary is being prepared. Showing the original description.

bioMate-AI/biomate-bioconductor-kb797Updated Jun 21, 2026

This tool uses the label-tree function from HyPhy to annotate a phylogenetic tree. It allows users to select a subset of leaves using either a regular expression or a list of sequence names, and then apply a specified label to these selecte

The English summary is being prepared. Showing the original description.

bioMate-AI/biomate-bioconductor-kb797Updated Jun 21, 2026

This package provides a client for the Bioconductor AnnotationHub web resource. The AnnotationHub web resource provides a central location where genomic files (e.g., VCF, bed, wig) and other resources from standard locations (e.g., UCSC, En

The English summary is being prepared. Showing the original description.

bioMate-AI/biomate-bioconductor-kb797Updated Jun 21, 2026

apeglm provides Bayesian shrinkage estimators for effect sizes for a variety of GLM models, using approximation of the posterior for individual coefficients.

The English summary is being prepared. Showing the original description.

bioMate-AI/biomate-bioconductor-kb797Updated Jun 21, 2026

ASURAT is a software for single-cell data analysis. Using ASURAT, one can simultaneously perform unsupervised clustering and biological interpretation in terms of cell type, disease, biological process, and signaling pathway activity. Inputting a single-cell RNA-seq data and knowledge-based databases, such as Cell Ontology, Gene Ontology, KEGG, etc., ASURAT transforms gene expression tables into original multivariate tables, termed sign-by-sample matrices (SSMs).

The English summary is being prepared. Showing the original description.

bioMate-AI/biomate-bioconductor-kb797Updated Jun 21, 2026

AUCell allows to identify cells with active gene sets (e.g. signatures, gene modules...) in single-cell RNA-seq data. AUCell uses the "Area Under the Curve" (AUC) to calculate whether a critical subset of the input gene set is enriched with

The English summary is being prepared. Showing the original description.

bioMate-AI/biomate-bioconductor-kb797Updated Jun 21, 2026

See all skills by bioMate-AI

Report a problem with this skill