Diff of /man/as.VoltRon.Rd [000000] .. [413088]

Switch to side-by-side view

--- a
+++ b/man/as.VoltRon.Rd
@@ -0,0 +1,45 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/allgenerics.R, R/conversion.R
+\name{as.VoltRon}
+\alias{as.VoltRon}
+\alias{as.VoltRon.Seurat}
+\alias{as.VoltRon.SpatialExperiment}
+\title{as.VoltRon}
+\usage{
+as.VoltRon(object, ...)
+
+\method{as.VoltRon}{Seurat}(
+  object,
+  type = c("image", "spatial"),
+  assay_name = NULL,
+  verbose = TRUE,
+  ...
+)
+
+\method{as.VoltRon}{SpatialExperiment}(
+  object,
+  assay_type = "cell",
+  assay_name = NULL,
+  image_id = NULL,
+  verbose = TRUE,
+  ...
+)
+}
+\arguments{
+\item{object}{a Seurat or SpatialExperiment object}
+
+\item{...}{Additional parameter passed to \link{formVoltRon}}
+
+\item{type}{the spatial data type of Seurat object: "image" or "spatial"}
+
+\item{assay_name}{the assay name of the voltron assays (e.g. Visium, Xenium etc.)}
+
+\item{verbose}{verbose}
+
+\item{assay_type}{one of two types, 'cell' or 'spot' etc.}
+
+\item{image_id}{select image_id names if needed.}
+}
+\description{
+Generic methods for conversion into a VoltRon object
+}