diff --git a/R/giotto.R b/R/giotto.R index 1d3dce7d1..50c740ec8 100644 --- 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 index e1588ddae..a803c5687 100644 --- a/man/createGiottoInstructions.Rd +++ b/man/createGiottoInstructions.Rd @@ -79,22 +79,19 @@ Function to set global instructions for giotto functions } - -Example: - -``` - 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 +} +\examples{ +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") -``` +giotto_object <- createGiottoObject(raw_exprs = '/path/to/expression/matrix', + spatial_locs = '/path/to/spatial/locations', + instructions = instructions) -Specific saving instructions can also be directly provided for each plotting function. -See \code{\link{showSaveParameters}} for more details } \seealso{ More online information can be found here \url{https://rubd.github.io/Giotto_site/articles/instructions_and_plotting.html}