getCoordsDf.Rd
Extracts the coordinates data.frame of the identified or known entities the analysis revolves around.
getCoordsDf(object, ...)
# S4 method for class 'SPATA2'
getCoordsDf(
object,
variables = NULL,
img_name = activeImage(object),
exclude = TRUE,
as_is = FALSE,
...
)
# S4 method for class 'SpatialData'
getCoordsDf(
object,
img_name = activeImage(object),
scale = TRUE,
wh = FALSE,
as_is = FALSE,
...
)
An object of class SPATA2
or, in case of S4 generics,
objects of classes for which a method has been defined.
Additional arguments given to joinWithVariables()
if argument
variables
is specified.
Character or NULL
. If character, specifies the
variables that are merged to the coordinates data.frame via joinWithVariables()
.
Only relevant if the SPATA2
object contains images. If so,
specifies the name of the image to which the original coordinates are scaled.
If NULL
, defaults to the active image.
Data.frame that, among others, contains at least the variables x_orig, y_orig and barcodes