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

Switch to side-by-side view

--- a
+++ b/man/Metadata.Rd
@@ -0,0 +1,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.
+}