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

Switch to unified view

a b/man/formAssay.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/assay.R
3
\name{formAssay}
4
\alias{formAssay}
5
\title{formAssay}
6
\usage{
7
formAssay(
8
  data = NULL,
9
  coords,
10
  segments = list(),
11
  image = NULL,
12
  params = list(),
13
  type = "ROI",
14
  name = "Assay1",
15
  main_image = "image_1",
16
  main_featureset = NULL,
17
  assay_version = "v2",
18
  ...
19
)
20
}
21
\arguments{
22
\item{data}{the feature matrix of spatialpoints}
23
24
\item{coords}{the coordinates of the spatial points}
25
26
\item{segments}{the list of segments each associated with a spatial point (optional)}
27
28
\item{image}{a singelton or list of images as magick-image objects}
29
30
\item{params}{additional parameters of the object}
31
32
\item{type}{the type of the assay (tile, molecule, cell, spot or ROI)}
33
34
\item{name}{the name of the assay}
35
36
\item{main_image}{the name of the main_image}
37
38
\item{main_featureset}{the name of the main_featureset}
39
40
\item{assay_version}{the assay version}
41
42
\item{...}{additional arguements passed to \link{formImage}}
43
}
44
\description{
45
Create a vrAssay (VoltRon assay) object
46
}