chore: update docs for spatPlot2D()

R/vis_spatial.R

@@ -481,9 +481,6 @@
 #' @param theme_param list of additional params passed to `ggplot2::theme()`
 #' @details coord_fix_ratio: set to NULL to use default ggplot parameters
 #' @returns ggplot
-#' @examples
-#' g <- GiottoData::loadGiottoMini("visium")
-#' spatPlot2D(g)
 #' @export
 spatPlot2D <- function(
         gobject,
@@ -760,8 +757,20 @@ spatPlot2D <- function(
 #' @family spatial visualizations
 #' @returns ggplot
 #' @examples
-#' g <- GiottoData::loadGiottoMini("visium")
-#' spatPlot(g)
+#' g <- GiottoData::loadGiottoMini("visium", verbose = FALSE)
+#' spatPlot(g, show_image = TRUE, image_name = "image")
+#'
+#' # the more specific spatPlot2D with networks shown
+#' spatPlot2D(g, show_image = TRUE, image_name = "image", show_network = TRUE)
+#'
+#' # plotting of some cell metadata (number of different features detected)
+#' spatPlot2D(g,
+#'     show_image = TRUE,
+#'     image_name = "image",
+#'     cell_color = "nr_feats",
+#'     color_as_factor = FALSE,
+#'     gradient_style = "sequential"
+#' )
 #' @export
 #' @seealso \code{\link{spatPlot3D}}
 spatPlot <- function(...) {