|
a |
|
b/man/Metadata.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/allgenerics.R, R/objects.R |
|
|
3 |
\name{Metadata} |
|
|
4 |
\alias{Metadata} |
|
|
5 |
\alias{Metadata<-} |
|
|
6 |
\alias{Metadata,VoltRon-method} |
|
|
7 |
\alias{Metadata<-,VoltRon-method} |
|
|
8 |
\title{Metadata} |
|
|
9 |
\usage{ |
|
|
10 |
Metadata(object, ...) |
|
|
11 |
|
|
|
12 |
Metadata(object, ...) <- value |
|
|
13 |
|
|
|
14 |
\S4method{Metadata}{VoltRon}(object, assay = NULL, type = NULL) |
|
|
15 |
|
|
|
16 |
\S4method{Metadata}{VoltRon}(object, assay = NULL, type = NULL) <- value |
|
|
17 |
} |
|
|
18 |
\arguments{ |
|
|
19 |
\item{object}{a VoltRon object.} |
|
|
20 |
|
|
|
21 |
\item{...}{arguments passed to other methods.} |
|
|
22 |
|
|
|
23 |
\item{value}{new metadata} |
|
|
24 |
|
|
|
25 |
\item{assay}{assay name (exp: Assay1) or assay class (exp: Visium, Xenium), see \link{SampleMetadata}. |
|
|
26 |
if NULL, the default assay will be used, see \link{vrMainAssay}.} |
|
|
27 |
|
|
|
28 |
\item{type}{the assay type: ROI, spot or cell, or all for the entire metadata object} |
|
|
29 |
} |
|
|
30 |
\description{ |
|
|
31 |
Get the metadata of a VoltRon object. |
|
|
32 |
} |