Package: SpatialFeatureExperiment 1.7.0

Lambda Moses

SpatialFeatureExperiment: Integrating SpatialExperiment with Simple Features in sf

A new S4 class integrating Simple Features with the R package sf to bring geospatial data analysis methods based on vector data to spatial transcriptomics. Also implements management of spatial neighborhood graphs and geometric operations. This pakage builds upon SpatialExperiment and SingleCellExperiment, hence methods for these parent classes can still be used.

Authors:Lambda Moses [aut, cre], Alik Huseynov [aut], Lior Pachter [aut, ths]

SpatialFeatureExperiment_1.7.0.tar.gz
SpatialFeatureExperiment_1.7.0.zip(r-4.5)SpatialFeatureExperiment_1.7.0.zip(r-4.4)SpatialFeatureExperiment_1.7.0.zip(r-4.3)
SpatialFeatureExperiment_1.7.0.tgz(r-4.4-any)SpatialFeatureExperiment_1.7.0.tgz(r-4.3-any)
SpatialFeatureExperiment_1.7.0.tar.gz(r-4.5-noble)SpatialFeatureExperiment_1.7.0.tar.gz(r-4.4-noble)
SpatialFeatureExperiment_1.7.0.tgz(r-4.4-emscripten)SpatialFeatureExperiment_1.7.0.tgz(r-4.3-emscripten)
SpatialFeatureExperiment.pdf |SpatialFeatureExperiment.html
SpatialFeatureExperiment/json (API)
NEWS

# Install 'SpatialFeatureExperiment' in R:
install.packages('SpatialFeatureExperiment', repos = c('https://bioc.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/pachterlab/spatialfeatureexperiment/issues

Datasets:

On BioConductor:SpatialFeatureExperiment-1.7.0(bioc 3.20)SpatialFeatureExperiment-1.6.1(bioc 3.19)

bioconductor-package

160 exports 2.46 score 137 dependencies 1 dependents

Last updated 2 months agofrom:2ef9eae05d

Exports:.check_features.check_sample_id.rm_empty_geometries.symbol2id.value2df.warn_symbol_duplicateaddImgaddSelectTxaddTxSpotsaddTxTechaddVisiumSpotPolyaffineaffineImgaggBboxesannotGeometriesannotGeometries<-annotGeometryannotGeometry<-annotGeometryNamesannotGeometryNames<-annotGraphannotGraph<-annotGraphNamesannotGraphNames<-annotGraphsannotGraphs<-annotNPredannotOpannotPredannotSummarybboxbbox_centerBioFormatsImagecbindcellSegcellSeg<-centroidscentroids<-changeSampleIDscolDatacolData<-colFeatureDatacolGeometriescolGeometries<-colGeometrycolGeometry<-colGeometryNamescolGeometryNames<-colGraphcolGraph<-colGraphNamescolGraphNames<-colGraphscolGraphs<-countscropcropImgdf2sfdimGeometriesdimGeometries<-dimGeometrydimGeometry<-dimGeometryNamesdimGeometryNames<-extext<-ExtImagefindSpatialNeighborsfindVisiumGraphformatTxSpotsformatTxTechgdalParquetAvailablegeometryFeatureDatagetImggetParamsgetPixelSizeimageIDsImg<-imgDataimgRasterimgSourceisFulllocalResultlocalResult<-localResultAttrslocalResultFeatureslocalResultNameslocalResultNames<-localResultslocalResults<-logcountsmirrormirrorImgnucSegnucSeg<-originread10xVisiumSFEreadCosMXreadSelectTxreadVizgenreadXeniumreducedDimreducedDimFeatureDataremoveEmptySpacermvImgROIPolyROIPoly<-rotaterotateImgrowDatarowFeatureDatarowGeometriesrowGeometries<-rowGeometryrowGeometry<-rowGeometryNamesrowGeometryNames<-rowGraphrowGraph<-rowGraphNamesrowGraphNames<-rowGraphsrowGraphs<-sampleIDssaveRDSscalescaleImgSFEVersionshowspatialCoordsspatialCoords<-spatialCoordsNamesSpatialFeatureExperimentspatialGraphspatialGraph<-spatialGraphNamesspatialGraphNames<-spatialGraphsspatialGraphs<-SpatRasterImagespotPolyspotPoly<-st_any_intersectsst_any_predst_n_intersectsst_n_predtissueBoundarytissueBoundary<-toExtImagetoSpatialFeatureExperimenttoSpatRasterImagetransformationtranslatetranslateImgtransposetransposeImgtxSpotstxSpots<-unitupdateObject

Dependencies:abindaskpassbase64encbeachmatBHBiobaseBiocFileCacheBiocGenericsBiocNeighborsBiocParallelbitbit64bitopsblobbootbslibcachemclassclassIntclicodetoolscpp11crayoncurldata.tableDBIdbplyrDelayedArrayDelayedMatrixStatsdeldirdigestdplyrdqrngDropletUtilse1071EBImageedgeRevaluatefansifastmapfftwtoolsfilelockfontawesomeformatRfsfutile.loggerfutile.optionsgenericsGenomeInfoDbGenomeInfoDbDataGenomicRangesgeometriesglueHDF5ArrayhighrhtmltoolshtmlwidgetshttrIRangesjpegjquerylibjsonliteKernSmoothknitrlambda.rlatticelifecyclelimmalocfitmagickmagrittrMASSMatrixMatrixGenericsmatrixStatsmemoisemimeopensslpillarpkgconfigplogrpngproxypurrrR.methodsS3R.ooR.utilsR6rappdirsRcppRcppHNSWRCurlrhdf5rhdf5filtersRhdf5librjsonrlangrmarkdownRSQLites2S4ArraysS4VectorssassscuttlesfsfheadersSingleCellExperimentsitmosnowspSparseArraysparseMatrixStatsSpatialExperimentspDataspdepstatmodstringistringrSummarizedExperimentsysterratibbletidyrtidyselecttifftinytexUCSC.utilsunitsutf8vctrswithrwkxfunXVectoryamlzeallotzlibbioc

Introduction to the SpatialFeatureExperiment class

Rendered fromSFE.Rmdusingknitr::rmarkdownon Jun 16 2024.

Last update: 2024-05-17
Started: 2022-03-30

Readme and manuals

Help Manual

Help pageTopics
Add Visium spot polygons to colGeometryaddVisiumSpotPoly
Affine transformation of imagesaffineImg affineImg,BioFormatsImage-method affineImg,ExtImage-method affineImg,SpatRasterImage-method
Aggregate bounding boxesaggBboxes
Annotation geometry methodsannotGeometries annotGeometries,SpatialFeatureExperiment-method annotGeometries<- annotGeometries<-,SpatialFeatureExperiment-method annotGeometry annotGeometry,SpatialFeatureExperiment-method annotGeometry<- annotGeometry<-,SpatialFeatureExperiment-method annotGeometryNames annotGeometryNames,SpatialFeatureExperiment-method annotGeometryNames<- annotGeometryNames<-,SpatialFeatureExperiment,character-method tissueBoundary tissueBoundary<-
Binary operations for geometry of each cell/spot and annotationannotOp
Binary predicates for geometry of each cell/spot and annotationannotNPred annotPred
Summarize attributes of an annotGeometry for each cell/spotannotSummary
Find center of bounding boxbbox_center
Find bounding box of SFE objectsbbox bbox,SpatialFeatureExperiment-method
On disk representation of BioFormats images in SFE objectBioFormatsImage BioFormatsImage-class show,BioFormatsImage-method
Other 'BioFormatsImage' gettersBioFormatsImage-getters isFull isFull,BioFormatsImage-method origin origin,BioFormatsImage-method transformation transformation,BioFormatsImage-method
Concatenate SpatialFeatureExperiment objectscbind,SpatialFeatureExperiment-method
Change sample IDschangeSampleIDs
Get global spatial analysis results and metadata of colData, rowData, and geometriescolFeatureData geometryFeatureData reducedDimFeatureData rowFeatureData
Column geometry getters and setterscellSeg cellSeg<- centroids centroids<- colGeometries colGeometries<- colGeometry colGeometry<- colGeometryNames colGeometryNames<- nucSeg nucSeg<- ROIPoly ROIPoly<- spotPoly spotPoly<-
Crop an SFE object with a geometrycrop
Crop imagescropImg cropImg,BioFormatsImage-method cropImg,ExtImage-method cropImg,SpatRasterImage-method
From ordinary data frame to sf to construct SFE objectdf2sf
Find dimension of BioFormatsImagedim,BioFormatsImage-method
Dimension geometry methodsdimGeometries dimGeometries,SpatialFeatureExperiment-method dimGeometries<- dimGeometries<-,SpatialFeatureExperiment-method dimGeometry dimGeometry,SpatialFeatureExperiment-method dimGeometry<- dimGeometry<-,SpatialFeatureExperiment-method dimGeometryNames dimGeometryNames,SpatialFeatureExperiment-method dimGeometryNames<- dimGeometryNames<-,SpatialFeatureExperiment,numeric,character-method
Get and set extent of image objectsext ext,BioFormatsImage-method ext,ExtImage-method ext,SpatRasterImage-method ext<-,BioFormatsImage,numeric-method ext<-,ExtImage,numeric-method ext<-,SpatRasterImage,numeric-method
Use the EBImage 'Image' class in SFE objectsExtImage ExtImage-class show,ExtImage-method
Find spatial neighborhood graphfindSpatialNeighbors findSpatialNeighbors,SpatialFeatureExperiment-method
Find spatial neighborhood graphs for Visium spotsfindVisiumGraph
Read and process transcript spots geometry for SFEaddTxSpots formatTxSpots
Read and process transcript spots for specific commercial technologiesaddTxTech formatTxTech
Check if Parquet GDAL driver is availablegdalParquetAvailable
Get parameters used in spatial methodsgetParams
Get physical size of pixelsgetPixelSize
Show all image_ids in the SFE objectimageIDs
Image setterImg<- Img<-,SpatialExperiment-method
Get the image from *Image classimgRaster imgRaster,BioFormatsImage-method imgRaster,ExtImage-method imgRaster,SpatRasterImage-method
Source of images that are on diskimgSource imgSource,BioFormatsImage-method imgSource,ExtImage-method imgSource,SpatRasterImage-method
Get and set results from local spatial statisticslocalResult localResult,SpatialFeatureExperiment-method localResult<- localResult<-,SpatialFeatureExperiment-method localResultAttrs localResultAttrs,SpatialFeatureExperiment-method localResultFeatures localResultFeatures,SpatialFeatureExperiment-method localResultNames localResultNames,SpatialFeatureExperiment-method localResultNames<- localResultNames<-,SpatialFeatureExperiment,character-method localResults localResults,SpatialFeatureExperiment-method localResults<- localResults<-,SpatialFeatureExperiment-method
Mirror/flip imagesmirrorImg mirrorImg,BioFormatsImage-method mirrorImg,ExtImage-method mirrorImg,SpatRasterImage-method
Read 10X Visium data as SpatialFeatureExperimentread10xVisiumSFE
Read CosMX data into SFEreadCosMX
Read transcript spots of select genesaddSelectTx readSelectTx
Read Vizgen MERFISH output as SpatialFeatureExperimentreadVizgen
Read 10X Xenium output as SpatialFeatureExperimentreadXenium
Functions re-exported from other packagescolData colData<- counts getImg imgData logcounts reducedDim reexports rmvImg rowData spatialCoords spatialCoords<- spatialCoordsNames
Remove empty spaceremoveEmptySpace
Rotate imagerotateImg rotateImg,BioFormatsImage-method rotateImg,ExtImage-method rotateImg,SpatRasterImage-method
Row geometry getters and settersrowGeometries rowGeometries<- rowGeometry rowGeometry<- rowGeometryNames rowGeometryNames<- txSpots txSpots<-
Get all unique sample IDssampleIDs
Save SpatialFeatureExperiment as RDS filesaveRDS,SpatialFeatureExperiment-method
Scale imagescaleImg scaleImg,AlignedSpatialImage-method
Methods for handling image-related dataaddImg,SpatialFeatureExperiment-method affineImg,SpatialFeatureExperiment-method mirrorImg,SpatialFeatureExperiment-method rotateImg,SpatialFeatureExperiment-method scaleImg,SpatialFeatureExperiment-method SFE-image translateImg,SpatialFeatureExperiment-method transposeImg,SpatialFeatureExperiment-method
Affine transfortaion of SFE object in histological spaceaffine mirror rotate scale SFE-transform translate transpose
Print method for SpatialFeatureExperimentshow,SpatialFeatureExperiment-method
Constructor of SpatialFeatureExperiment objectSpatialFeatureExperiment
The SpatialFeatureExperiment classSpatialFeatureExperiment-class
SpatialFeatureExperiment coercion methodsSpatialFeatureExperiment-coercion toSpatialFeatureExperiment toSpatialFeatureExperiment,Seurat-method toSpatialFeatureExperiment,SingleCellExperiment-method toSpatialFeatureExperiment,SpatialExperiment-method
Subsetting SpatialFeatureExperiment objectsSpatialFeatureExperiment-subset [,SpatialFeatureExperiment,ANY,ANY,ANY-method
Spatial graph methodsannotGraph annotGraph<- annotGraphNames annotGraphNames<- annotGraphs annotGraphs<- colGraph colGraph<- colGraphNames colGraphNames<- colGraphs colGraphs<- rowGraph rowGraph<- rowGraphNames rowGraphNames<- rowGraphs rowGraphs<- spatialGraph spatialGraph,SpatialFeatureExperiment-method spatialGraph<- spatialGraph<-,SpatialFeatureExperiment-method spatialGraphNames spatialGraphNames,SpatialFeatureExperiment,numeric-method spatialGraphNames<- spatialGraphNames<-,SpatialFeatureExperiment,numeric,ANY,character-method spatialGraphs spatialGraphs,SpatialFeatureExperiment-method spatialGraphs<- spatialGraphs<-,SpatialFeatureExperiment-method
SpatRaster representation of images in SFE objectsshow,SpatRasterImage-method SpatRasterImage SpatRasterImage-class
Simple geometry predicatesst_any_intersects st_any_pred st_n_intersects st_n_pred
Convert images to ExtImagetoExtImage toExtImage,BioFormatsImage-method toExtImage,SpatRasterImage-method
Convert images to SpatRasterImagetoSpatRasterImage toSpatRasterImage,BioFormatsImage-method toSpatRasterImage,ExtImage-method
Translate/shift image in spacetranslateImg translateImg,BioFormatsImage-method translateImg,ExtImage-method translateImg,SpatRasterImage-method
Transpose imagestransposeImg transposeImg,BioFormatsImage-method transposeImg,ExtImage-method transposeImg,SpatRasterImage-method
Get unit of a SpatialFeatureExperimentunit unit,SpatialFeatureExperiment-method
Update a SpatialFeatureExperiment objectSFEVersion updateObject updateObject,SpatialFeatureExperiment-method
Row and columns of Visium barcodes on the slidevisium_row_col