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

Switch to unified view

a b/man/flipCoordinates.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/allgenerics.R, R/objects.R, R/assay.R
3
\name{flipCoordinates}
4
\alias{flipCoordinates}
5
\alias{flipCoordinates,VoltRon-method}
6
\alias{flipCoordinates,vrAssay-method}
7
\alias{flipCoordinates,vrAssayV2-method}
8
\title{flipCoordinates}
9
\usage{
10
flipCoordinates(object, ...)
11
12
\S4method{flipCoordinates}{VoltRon}(
13
  object,
14
  assay = NULL,
15
  image_name = NULL,
16
  spatial_name = NULL,
17
  ...
18
)
19
20
\S4method{flipCoordinates}{vrAssay}(object, image_name = NULL, spatial_name = NULL, ...)
21
22
\S4method{flipCoordinates}{vrAssayV2}(object, image_name = NULL, spatial_name = NULL, ...)
23
}
24
\arguments{
25
\item{object}{a VoltRon, vrAssay or vrSpatial object.}
26
27
\item{...}{additional parameters passed to \link{vrCoordinates} and \link{vrSegments}}
28
29
\item{assay}{assay name (exp: Assay1) or assay class (exp: Visium, Xenium), see \link{SampleMetadata}. 
30
if NULL, the default assay will be used, see \link{vrMainAssay}.}
31
32
\item{image_name}{(deprecated, use \code{spatial_name}) the name/key of the image}
33
34
\item{spatial_name}{the name/key of the spatial system associated with the coordinates}
35
}
36
\description{
37
Flip the coordinates of spatial points in the y axis direction.
38
}