Diff of /man/vrMainImage.Rd [000000] .. [413088]

Switch to unified view

a b/man/vrMainImage.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/allgenerics.R, R/image.R
3
\name{vrMainImage}
4
\alias{vrMainImage}
5
\alias{vrMainImage,VoltRon-method}
6
\alias{vrMainImage,vrAssay-method}
7
\alias{vrMainImage,vrAssayV2-method}
8
\alias{vrMainImage<-,VoltRon-method}
9
\alias{vrMainImage<-,vrAssay-method}
10
\alias{vrMainImage<-,vrAssayV2-method}
11
\alias{vrMainImage<-}
12
\title{vrMainImage}
13
\usage{
14
vrMainImage(object, ...)
15
16
\S4method{vrMainImage}{VoltRon}(object, assay = NULL)
17
18
\S4method{vrMainImage}{vrAssay}(object)
19
20
\S4method{vrMainImage}{vrAssayV2}(object)
21
22
\S4method{vrMainImage}{VoltRon}(object, assay = NULL) <- value
23
24
\S4method{vrMainImage}{vrAssay}(object, ignore = FALSE) <- value
25
26
\S4method{vrMainImage}{vrAssayV2}(object, ignore = FALSE) <- value
27
28
vrMainImage(object, ...) <- value
29
}
30
\arguments{
31
\item{object}{a VoltRon or vrAssay object.}
32
33
\item{...}{arguments passed to other methods.}
34
35
\item{assay}{assay name (exp: Assay1) or assay class (exp: Visium, Xenium), see \link{SampleMetadata}. 
36
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.}
37
38
\item{value}{the name of main spatial coordinate system.}
39
40
\item{ignore}{if TRUE, the non-existing spatial coordinate system will be ignored.}
41
}
42
\description{
43
Get the main image
44
45
Set the main image
46
}