chore: document & examples for ext()

NEWS.md

@@ -13,7 +13,7 @@
 - `plot()` `giottoPoints` method now plots density when `dens = TRUE`
 - `show_max` param `density()` and `hist()` to show the image object's `max_window` setting
 - `.identify_background_range_polygons()` now finds any polygons larger than a threshold percentage than the overall extent of the `SpatVector` input.
-- `ext()` can now be used with the `giotto` object
+- `ext()` can now be used with `giotto` objects
 
 ## new
 - new `spatValues()` to get specific values from a `giotto` object in `data.table` format

R/methods-ext.R

@@ -10,9 +10,33 @@
 #' @param ... additional params to pass
 #' @returns SpatExtent
 #' @examples
-#' g <- GiottoData::loadSubObjectMini("spatLocsObj")
-#' 
+#' g <- GiottoData::loadGiottoMini("vizgen")
+#' # giotto %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 #' ext(g)
+#'
+#' # spatLocsObj %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+#' sl <- getSpatialLocations(g)
+#' ext(sl)
+#'
+#' # giottoPolygon %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+#' # get extent
+#' #' gpoly <- getPolygonInfo(g, return_giottoPolygon = TRUE)
+#' ext(gpoly)
+#'
+#' # set extent
+#' plot(gpoly) # before
+#' ext(gpoly) <- ext(0, 20, 30, 60)
+#' plot(gpoly) # after
+#'
+#' # giottoPoints %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+#' # get extent
+#' gpoints <- getFeatureInfo(g, return_giottoPoints = TRUE)
+#' ext(gpoints)
+#'
+#' # set extent
+#' plot(gpoints) # before
+#' ext(gpoints) <- ext(0, 2000, 3000, 6000)
+#' plot(gpoints) # after
 NULL