Skip to contents

Spatially query polygons within Giotto object

Source: R/spatial_query.R
spatQueryGiottoPolygons.Rd

Recursively select polygons based on a list of spatial filters. Results will be returned as a new polygon-based spatial unit with selection information recorded in the associated cell metadata. The final item in provided in param filters is the layer of information being queried.

Usage

spatQueryGiottoPolygons(
  gobject,
  filters,
  name = "query_polys",
  feat_type = NULL,
  clip = TRUE
)

Arguments

gobject

Giotto object

filters

list of characters. Named list of IDs to query on as spatial filters where the names designate the spatial unit to use and the character values should either be 'all' or a vector of cell_IDs to use.

name

(optional) character. If not NULL, a new spatial unit of this name will be generated from the results

feat_type

(optional) May be changed in future. Determines which feature type metadata in which hierarchical selection information is stored.

clip

boolean. Default = FALSE. Whether final round of querying should return polygons clipped by the polygons used to select them. If TRUE, a value must be provided to name param to generate a new spatial unit

Value

giottoPolygon

See also

relate()