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

Switch to side-by-side view

--- a
+++ b/man/vrEmbeddings.Rd
@@ -0,0 +1,48 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/allgenerics.R, R/objects.R, R/assay.R
+\name{vrEmbeddings}
+\alias{vrEmbeddings}
+\alias{vrEmbeddings,VoltRon-method}
+\alias{vrEmbeddings,vrAssay-method}
+\alias{vrEmbeddings,vrAssayV2-method}
+\alias{vrEmbeddings<-,vrAssay-method}
+\alias{vrEmbeddings<-,vrAssayV2-method}
+\alias{vrEmbeddings<-,VoltRon-method}
+\alias{vrEmbeddings<-}
+\title{vrEmbeddings}
+\usage{
+vrEmbeddings(object, ...)
+
+\S4method{vrEmbeddings}{VoltRon}(object, assay = NULL, type = "pca", dims = seq_len(30))
+
+\S4method{vrEmbeddings}{vrAssay}(object, type = "pca", dims = seq_len(30))
+
+\S4method{vrEmbeddings}{vrAssayV2}(object, type = "pca", dims = seq_len(30))
+
+\S4method{vrEmbeddings}{vrAssay}(object, type = "pca") <- value
+
+\S4method{vrEmbeddings}{vrAssayV2}(object, type = "pca") <- value
+
+\S4method{vrEmbeddings}{VoltRon}(object, assay = NULL, type = "pca", overwrite = FALSE) <- value
+
+vrEmbeddings(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}.}
+
+\item{type}{the key name for the embedding}
+
+\item{dims}{the set of dimensions of the embedding data}
+
+\item{value}{new embedding data}
+
+\item{overwrite}{Whether the existing embedding with name 'type' should be overwritten}
+}
+\description{
+Given a VoltRon or vrAssay object, get embeddings of spatial points
+}