createGroupAnnotations.RdCreates spatial annotations based on the spatial extent of a group of data points (spots or cells). See details for more information.
createGroupAnnotations(
object,
grouping,
group,
id,
tags = NULL,
tags_expand = TRUE,
use_dbscan = TRUE,
inner_borders = TRUE,
eps = recDbscanEps(object),
minPts = recDbscanMinPts(object),
min_size = nObs(object) * 0.01,
force1 = FALSE,
concavity = 2,
overwrite = FALSE,
verbose = NULL
)An object of class SPATA2 or, in case of S4 generics,
objects of classes for which a method has been defined.
Character value. The grouping variable containing the group of interest.
Character value. The group of interest.
Character value. The ID of the spatial annotation. If NULL,
the ID of the annotation is created by combining the string 'spat_ann' with
the index the new annotation has in the list of all annotations.
A character vector of tags for the spatial annotation.
Logical value. If TRUE, the tags with which the image
annotations are tagged are expanded by the unsuffixed id, the grouping,
the group and 'createGroupAnnotations'.
Logical value. If TRUE, the DBSCAN algorithm is used to identify
spatial clusters and outliers before the outline of the spatial annotation is drawn.
Logical value. If TRUE, the algorithm checks whether the
annotation requires inner borders and sets them accordingly. If FALSE, only
an outer border is created.
Distance measure. Given to eps of dbscan::dbscan(). Determines
the size (radius) of the epsilon neighborhood.
Numeric value. Given to dbscan::dbscan(). Determines the
number of minimum points required in the eps neighborhood for core points
(including the point itself)
Numeric value. The minimum number of data points a dbscan cluster must have in order not to be discarded as a spatial outlier.
Logical value. If TRUE, spatial sub groups identified by DBSCAN
are merged into one cluster. Note: If FALSE (the default), the input for ìd is suffixed
with an index to label each spatial annotation created uniquely, regardless of
how many are eventually created. E.g. if id = "my_ann" and the algorithm
created two spatial annotations, they are named my_ann_1 and my_ann_2.
Numeric value. Given to argument concavity of
concaveman::concaveman(). Determines the relative measure of concavity.
1 results in a relatively detailed shape, Infinity results in a convex hull.
You can use values lower than 1, but they can produce pretty crazy shapes.
Logical value. Must be TRUE to allow overwriting.
Logical. If TRUE, informative messages regarding
the computational progress will be printed.
(Warning messages will always be printed.)
The updated input object, containing the added, removed or computed results.
The functions filters the coordinates data.frame obtained via getCoordsDf()
based on the input of argument grouping and group.
Following filtering, if use_dbscan is TRUE, the DBSCAN algorithm
identifies spatial outliers, which are then removed. Furthermore, if DBSCAN
detects multiple dense clusters, they can be merged into a single group
if force1 is also set to TRUE.
It is essential to note that bypassing the DBSCAN step may lead to the inclusion
of individual data points dispersed across the sample. This results in an image
annotation that essentially spans the entirety of the sample, lacking the
segregation of specific variable expressions. Similarly, enabling force1
might unify multiple segregated areas, present on both sides of the sample, into one
group and subsequently, one image annotation encompassing the whole sample.
Consider to allow the creation of multiple spatial annotations (suffixed with an index)
and merging them afterwards via mergeSpatialAnnotations() if they are too
close together.
Lastly, the remaining data points are fed into the concaveman algorithm on a
per-group basis. The algorithm calculates concave polygons outlining the groups
of data points. If dbscan_use is FALSE, all data points that remained after the
initial filtering are submitted to the algorithm. Subsequently, these polygons are
integrated into addSpatialAnnotation() along with the unsuffixed id and
tags input arguments. The ID is suffixed with an index for each group.
The vignette on distance measures in SPATA2 has been replaced. Click
here to read it.
library(SPATA2)
library(tidyverse)
data("example_data")
object <- example_data$object_UKF275T_diet
object <-
createGroupAnnotations(
object = object,
grouping = "bayes_space",
group = "1",
id = "bspace1",
tags = "bspace_ann"
)
plotSurface(object, color_by = "bayes_space") +
ggpLayerSpatAnnOutline(object, tags = "bspace_ann")