Skip to content

Latest commit

 

History

History
91 lines (65 loc) · 4.82 KB

README.md

File metadata and controls

91 lines (65 loc) · 4.82 KB
Raw


Website and Tutorials: https://bioinformatics.mdc-berlin.de/VoltRon

VoltRon is a spatial omic analysis toolbox for multi-omics integration using spatial image registration. VoltRon is also capable of analyzing multiple types of spatially-aware data modalities.

  • Unique Data Structure of VoltRon allows users to seamlessly define tissue blocks, layers and multiple assay types in one R object.
  • End-to-end downstream data analysis for distinct spatial biology technologies are supported. VoltRon visualizes and analyzes regions of interests (ROIs), spots, cells, molecules and tiles (under development).
  • Automated Image Registration incorporates OpenCV (fully embedded into the package using Rcpp) to detect common features across images and achieves registration. Users may interact with built-in mini shiny apps to change alignment parameters and validate alignment accuracy.
  • Manual Image Registration helps users to select common features across spatial datasets using reference images stored in VoltRon objects. In case automated image registration doesn't work, you can still align images by manually picking landmark points.
  • Niche Clustering allows integration to single cell RNA analysis datasets using Seurat, SingleCellExperiment and spacexr for spot deconvolution. Estimated cell type abundances are then used to cluster spots into groups of cell type niches which are defined as spots with distinct composition of cell types.

Staying up-to-date

To ask questions please use VoltRon discussion forum on google groups.

Installation

Install from the GitHub repository using devtools (with R version 4.3.0 or higher):

if (!require("devtools", quietly = TRUE))
    install.packages("devtools")
devtools::install_github("BIMSBbioinfo/VoltRon")

Depending on the number of required dependencies, installation may be completed under a minute or may take a few minutes.

On Windows and MacOS, OpenCV will be downloaded automatically upon installation. However, Rtools may be required to be downloaded too, hence this may take some time!

On Ubuntu we provide a set of instructions that may help users to build OpenCV with necessary headers here.

On Fedora you may need opencv-devel:

yum install opencv-devel

Tutorials

Please see the Explore section in the VoltRon website for tutorials, example scripts and analysis found in the preprint. Tutorials include links for accessing necessary data to run scripts across all tutorials.

References

Manukyan, A., Bahry, E., Wyler, E., Becher, E., Pascual-Reguant, A., Plumbom, I., ... & Akalin, A. (2023). VoltRon: A Spatial Omics Analysis Platform for Multi-Resolution and Multi-omics Integration using Image Registration. bioRxiv, 2023-12.