[413088]: / man / vrMainImage.Rd

Download this file

47 lines (34 with data), 1.4 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/allgenerics.R, R/image.R
\name{vrMainImage}
\alias{vrMainImage}
\alias{vrMainImage,VoltRon-method}
\alias{vrMainImage,vrAssay-method}
\alias{vrMainImage,vrAssayV2-method}
\alias{vrMainImage<-,VoltRon-method}
\alias{vrMainImage<-,vrAssay-method}
\alias{vrMainImage<-,vrAssayV2-method}
\alias{vrMainImage<-}
\title{vrMainImage}
\usage{
vrMainImage(object, ...)
\S4method{vrMainImage}{VoltRon}(object, assay = NULL)
\S4method{vrMainImage}{vrAssay}(object)
\S4method{vrMainImage}{vrAssayV2}(object)
\S4method{vrMainImage}{VoltRon}(object, assay = NULL) <- value
\S4method{vrMainImage}{vrAssay}(object, ignore = FALSE) <- value
\S4method{vrMainImage}{vrAssayV2}(object, ignore = FALSE) <- value
vrMainImage(object, ...) <- value
}
\arguments{
\item{object}{a VoltRon or vrAssay 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}. If given as "all", then provides a summary of spatial systems across all assays.}
\item{value}{the name of main spatial coordinate system.}
\item{ignore}{if TRUE, the non-existing spatial coordinate system will be ignored.}
}
\description{
Get the main image
Set the main image
}