[413088]: / man / vrCoordinates.Rd

Download this file

68 lines (50 with data), 2.2 kB

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/allgenerics.R, R/objects.R, R/assay.R,
% R/image.R
\name{vrCoordinates}
\alias{vrCoordinates}
\alias{vrCoordinates,VoltRon-method}
\alias{vrCoordinates,vrAssay-method}
\alias{vrCoordinates,vrAssayV2-method}
\alias{vrCoordinates,vrImage-method}
\alias{vrCoordinates,vrSpatial-method}
\alias{vrCoordinates<-,VoltRon-method}
\alias{vrCoordinates<-,vrAssay-method}
\alias{vrCoordinates<-,vrAssayV2-method}
\alias{vrCoordinates<-,vrImage-method}
\alias{vrCoordinates<-,vrSpatial-method}
\alias{vrCoordinates<-}
\title{vrCoordinates}
\usage{
vrCoordinates(object, ...)
\S4method{vrCoordinates}{VoltRon}(
object,
assay = NULL,
image_name = NULL,
spatial_name = NULL,
reg = FALSE
)
\S4method{vrCoordinates}{vrAssay}(object, image_name = NULL, spatial_name = NULL, reg = FALSE)
\S4method{vrCoordinates}{vrAssayV2}(object, image_name = NULL, spatial_name = NULL, reg = FALSE)
\S4method{vrCoordinates}{vrImage}(object)
\S4method{vrCoordinates}{vrSpatial}(object)
\S4method{vrCoordinates}{VoltRon}(object, image_name = NULL, spatial_name = NULL, reg = FALSE) <- value
\S4method{vrCoordinates}{vrAssay}(object, image_name = NULL, spatial_name = NULL, reg = FALSE) <- value
\S4method{vrCoordinates}{vrAssayV2}(object, image_name = NULL, spatial_name = NULL, reg = FALSE) <- value
\S4method{vrCoordinates}{vrImage}(object) <- value
\S4method{vrCoordinates}{vrSpatial}(object) <- value
vrCoordinates(object, ...) <- value
}
\arguments{
\item{object}{a VoltRon, vrAssay or vrSpatial object.}
\item{...}{arguments passed to other methods.}
\item{assay}{assay name (exp: Assay1) or assay class (exp: Visium, Xenium), see \link{SampleMetadata}.
if NULL, the default assay will be used, see \link{vrMainAssay}.}
\item{image_name}{(deprecated, use \code{spatial_name}) the name/key of the image associated with the coordinates}
\item{spatial_name}{the name/key of the spatial system associated with the coordinates}
\item{reg}{TRUE if registered coordinates of the main image (\link{vrMainImage}) is requested}
\item{value}{coordinates}
}
\description{
Given a VoltRon, vrAssay or vrSpatial object, get and set the coordinates of assays and coordinate systems
}