|
a |
|
b/man/as.AnnData.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/conversion.R |
|
|
3 |
\name{as.AnnData} |
|
|
4 |
\alias{as.AnnData} |
|
|
5 |
\title{as.AnnData} |
|
|
6 |
\usage{ |
|
|
7 |
as.AnnData( |
|
|
8 |
object, |
|
|
9 |
file, |
|
|
10 |
assay = NULL, |
|
|
11 |
flip_coordinates = FALSE, |
|
|
12 |
method = "anndata", |
|
|
13 |
create.ometiff = FALSE, |
|
|
14 |
python.path = NULL, |
|
|
15 |
... |
|
|
16 |
) |
|
|
17 |
} |
|
|
18 |
\arguments{ |
|
|
19 |
\item{object}{a VoltRon object} |
|
|
20 |
|
|
|
21 |
\item{file}{the name of the h5ad file.} |
|
|
22 |
|
|
|
23 |
\item{assay}{assay name (exp: Assay1) or assay class (exp: Visium, Xenium), see \link{SampleMetadata}. |
|
|
24 |
if NULL, the default assay will be used, see \link{vrMainAssay}.} |
|
|
25 |
|
|
|
26 |
\item{flip_coordinates}{if TRUE, the spatial coordinates (including segments) will be flipped.} |
|
|
27 |
|
|
|
28 |
\item{method}{the package to use for conversion: "anndataR" or "anndata".} |
|
|
29 |
|
|
|
30 |
\item{create.ometiff}{should an ometiff file be generated of default image of the object} |
|
|
31 |
|
|
|
32 |
\item{python.path}{the path to the python binary, otherwise either \code{basilisk} package is used or \code{getOption("voltron.python.path")} should be not NULL.} |
|
|
33 |
|
|
|
34 |
\item{...}{additional parameters passed to \link{vrImages}.} |
|
|
35 |
} |
|
|
36 |
\description{ |
|
|
37 |
Converting a VoltRon object into a AnnData (.h5ad) object |
|
|
38 |
} |
|
|
39 |
\details{ |
|
|
40 |
This function converts a VoltRon object into an AnnData object (.h5ad file). It extracts assay data, |
|
|
41 |
spatial coordinates, and optionally flips coordinates. Images associated with the assay can be included in the |
|
|
42 |
resulting AnnData file, with additional customization parameters like channel, scale.perc. |
|
|
43 |
} |