Browse code

Reintegrated coordinates param

davidecrs authored on 01/06/2021 08:12:38
Showing 2 changed files

... ...
@@ -8,6 +8,12 @@
8 8
 #'    Alternatively, a \linkS4class{SpatialExperiment} object.
9 9
 #'
10 10
 #' @param ... For the generic, arguments to pass to specific methods.
11
+#' @param coordinates A `data.frame` with sample coordinates. Each row is a
12
+#'   sample, the columns with coordinates should be named 'x' and 'y'.
13
+#'
14
+#'   For the *SpatialExperiment* method, coordinates are taken from
15
+#'   `spatialCoords(x)`.
16
+#'
11 17
 #' @param assay_type A `character` string specifying the assay from `x` to use
12 18
 #'   as input. Defaults to `"counts"`.
13 19
 #' @param verbose A `logical` controlling the display of a progress bar from the
... ...
@@ -32,7 +38,6 @@
32 38
 #'
33 39
 #' ## Run spatialDE
34 40
 #' de_results <- spatialDE(spe)
35
-#' head(de_results)
36 41
 #'
37 42
 #' @seealso
38 43
 #' The individual steps performed by this function: [stabilize()],
... ...
@@ -19,6 +19,12 @@ Alternatively, a \linkS4class{SpatialExperiment} object.}
19 19
 
20 20
 \item{...}{For the generic, arguments to pass to specific methods.}
21 21
 
22
+\item{coordinates}{A \code{data.frame} with sample coordinates. Each row is a
23
+sample, the columns with coordinates should be named 'x' and 'y'.
24
+
25
+For the \emph{SpatialExperiment} method, coordinates are taken from
26
+\code{spatialCoords(x)}.}
27
+
22 28
 \item{verbose}{A \code{logical} controlling the display of a progress bar from the
23 29
 Python package.}
24 30
 
... ...
@@ -50,7 +56,6 @@ spe <- mockSVG(size = 10, tot_genes = 200, de_genes = 20, return_SPE = TRUE)
50 56
 
51 57
 ## Run spatialDE
52 58
 de_results <- spatialDE(spe)
53
-head(de_results)
54 59
 
55 60
 }
56 61
 \references{