add returns value

R/classes.R

@@ -1670,6 +1670,7 @@ giottoLargeImage <- setClass(
 #' transforms
 #' @slot funs list of functions associated with the object. Primarily to
 #' perform the delayed/lazy operations
+#' @returns giottoAffineImage
 setClass(
     "giottoAffineImage",
     contains = c("giottoLargeImage"),

R/methods-extract.R

@@ -117,7 +117,7 @@ NULL
 #'     cell_ids = c("GAATCGCCGGACACGG-1", "GAGGGCATCGCGTATC-1")
 #' )
 #' subset(g, Gfap + Gna12 > 10)
-#'
+#' @returns giotto object
 NULL
 
 #' @title Subset `giotto` subobjects
@@ -149,7 +149,7 @@ NULL
 #' # return as a subset giotto object with drop = FALSE
 #' g[[, "raw", drop = FALSE]]
 #' g[[spat_unit = "aggregate", drop = FALSE]]
-#' 
+#' @returns giotto subobject
 NULL
 
 # --------------------------------------------------------------------------- #

R/methods-nesting.R

@@ -273,6 +273,7 @@ NULL
 #' @param force_replace logical. default = FALSE. Whether to replace the
 #' names of objects for which the name already has a name for
 #' @keywords internal
+#' @returns list
 assign_objnames_2_list <- function(obj_list, force_replace = FALSE) {
     if (is.null(obj_list)) {
         return(obj_list)

R/methods-show.R

@@ -7,6 +7,7 @@ NULL
 #' Create a text representation of an object
 #' @param x object
 #' @param ... additional params to pass (none implemented)
+#' @returns character
 #' @examples
 #' img <- GiottoData::loadSubObjectMini("giottoLargeImage")
 #' as.character(img)
@@ -628,6 +629,7 @@ setMethod(
 
 ## giottoPoints ####
 #' @rdname show
+#' @returns giotto slot
 setMethod("show", signature = "giottoPoints", function(object) {
     cat("An object of class giottoPoints\n")
     .show_feat(object)

R/python_environment.R

@@ -500,7 +500,7 @@ checkGiottoEnvironment <- function(envname = NULL,
 #'     temp_env <- tempdir()
 #'     installGiottoEnvironment(mini_install_path = temp_env)
 #' }
-#'
+#' @returns installed Giotto environment
 #' @export
 installGiottoEnvironment <- function(
         packages_to_install = c(