[413088]: / man / Metadata.Rd

Download this file

33 lines (25 with data), 878 Bytes

 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/allgenerics.R, R/objects.R
\name{Metadata}
\alias{Metadata}
\alias{Metadata<-}
\alias{Metadata,VoltRon-method}
\alias{Metadata<-,VoltRon-method}
\title{Metadata}
\usage{
Metadata(object, ...)
Metadata(object, ...) <- value
\S4method{Metadata}{VoltRon}(object, assay = NULL, type = NULL)
\S4method{Metadata}{VoltRon}(object, assay = NULL, type = NULL) <- value
}
\arguments{
\item{object}{a VoltRon object.}
\item{...}{arguments passed to other methods.}
\item{value}{new metadata}
\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{type}{the assay type: ROI, spot or cell, or all for the entire metadata object}
}
\description{
Get the metadata of a VoltRon object.
}