knitr::opts_chunk$set(
    collapse = TRUE,
    comment = "#>",
    fig.path = "man/figures/README-",
    out.width = "100%"
)

spatialDE

Lifecycle: experimental R-CMD-check-bioc Codecov test coverage BioC release status BioC devel status

The spatialDE package provides an R wrapper for the Python SpatialDE library, using r BiocStyle::CRANpkg("reticulate") and r BiocStyle::Biocpkg("basilisk").

SpatialDE, by Svensson et al., 2018, is a method to identify spatially variable genes (SVGs) in spatially resolved transcriptomics data.

This package started as part of the BiocSpatialChallenges.

Installation instructions

Get the latest stable R release from CRAN. Then install r BiocStyle::Biocpkg("spatialDE") from Bioconductor using the following code:

if (!requireNamespace("BiocManager", quietly = TRUE)) {
    install.packages("BiocManager")
}

BiocManager::install("spatialDE")

The development version of spatialDE can be installed from GitHub with:

if (!requireNamespace("BiocManager", quietly = TRUE)) {
    install.packages("BiocManager")

BiocManager::install("sales-lab/spatialDE")

Basic usage

library(spatialDE)
spe <- mockSVG(return_SPE = TRUE)
de_results <- spatialDE(spe)
head(de_results)

Citation

Below is the citation output from using citation('spatialDE') in R. Please run this yourself to check for any updates on how to cite spatialDE.

Please note that this package merely provides a wrapper to use the original Python methods in R. If you find these methods useful, please also consider citing the original paper.

print(citation('spatialDE'), bibtex = TRUE)

Code of Conduct

Please note that the spatialDE project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Useful links

This package was developed using r BiocStyle::Biocpkg('biocthis').



sales-lab/spatialDE documentation built on Feb. 12, 2024, 2:47 p.m.