move Example code to Examples section on createGiottoInstructions doc…

…umentation
drieslab · Nov 2, 2021 · 4fa97a3 · 4fa97a3
1 parent 9ccd8bd
commit 4fa97a3
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 27 deletions.
diff --git a/R/giotto.R b/R/giotto.R
@@ -327,23 +327,18 @@ set_giotto_python_path = function(python_path = NULL,
 #'
 #' }
 #'
+#'#' Specific saving instructions can also be directly provided for each plotting function.
+#' See \code{\link{showSaveParameters}} for more details
 #'
-#' Example:
-#'
-#' ```
-#'       instructions <- createGiottoInstruction(python_path = '/path/to/python',
-#'                                               save_plot = TRUE,
-#'                                               save_dir = '/path/to/working/dir'")
-#'
-#'
-#'       giotto_object <- createGiottoObject(raw_exprs = '/path/to/expression/matrix',
-#'                                           spatial_locs = '/path/to/spatial/locations',
-#'                                           instructions = instructions")
-#' ```
+#' @examples
+#' instructions <- createGiottoInstruction(python_path = '/path/to/python',
+#'                                         save_plot = TRUE,
+#'                                         save_dir = '/path/to/working/dir')
 #'
-#' Specific saving instructions can also be directly provided for each plotting function.
-#' See \code{\link{showSaveParameters}} for more details
 #'
+#' giotto_object <- createGiottoObject(raw_exprs = '/path/to/expression/matrix',
+#'                                     spatial_locs = '/path/to/spatial/locations',
+#'                                     instructions = instructions)
 #'
 createGiottoInstructions <- function(python_path =  NULL,
                                      show_plot = NULL,

diff --git a/man/createGiottoInstructions.Rd b/man/createGiottoInstructions.Rd