setPolygonInfo: Set polygon info

View source: R/accessors.R

setPolygonInfoR Documentation

Set polygon info

Description

Set polygon information into Giotto object

Usage

setPolygonInfo(
  gobject,
  x,
  name = "cell",
  centroids_to_spatlocs = FALSE,
  verbose = TRUE,
  initialize = TRUE
)

Arguments

gobject

giotto object

x

single object or named list of objects to set as polygon information (see details)

name

(optional, character) name to assign to polygon and spatial unit that polygon might define. Only used for single giottoPolygon objects. Names are taken from a named list for multiple polygons.

centroids_to_spatlocs

if centroid information is discovered, whether to additionally set them as a set of spatial locations (default = FALSE)

initialize

(default = FALSE) whether to initialize the gobject before returning

Details

Inputs can be provided as either single objects or named lists of objects. If the list is not named, then a generic name of the template 'cell_i' will be applied.
If an input is a character string, then it is assumed that it is a filepath.
For required formatting when reading tabular data or objects, see createGiottoPolygonsFromDfr details.

Value

giotto object

See Also

Other polygon info data accessor functions: getPolygonInfo(), get_polygon_info(), set_polygon_info()

Other functions to set data in giotto object: get_cell_id(), get_feat_id(), setCellMetadata(), setDimReduction(), setExpression(), setFeatureInfo(), setFeatureMetadata(), setGiottoImage(), setMultiomics(), setNearestNetwork(), setSpatialEnrichment(), setSpatialGrid(), setSpatialLocations(), setSpatialNetwork(), set_NearestNetwork(), set_cell_id(), set_cell_metadata(), set_dimReduction(), set_expression_values(), set_feat_id(), set_feature_info(), set_giottoImage(), set_multiomics(), set_polygon_info(), set_spatialGrid(), set_spatialNetwork(), set_spatial_enrichment(), set_spatial_locations()


drieslab/Giotto_site_suite documentation built on April 26, 2023, 11:51 p.m.