|
a |
|
b/man/vrEmbeddingFeaturePlot.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/visualization.R |
|
|
3 |
\name{vrEmbeddingFeaturePlot} |
|
|
4 |
\alias{vrEmbeddingFeaturePlot} |
|
|
5 |
\title{vrEmbeddingFeaturePlot} |
|
|
6 |
\usage{ |
|
|
7 |
vrEmbeddingFeaturePlot( |
|
|
8 |
object, |
|
|
9 |
embedding = "pca", |
|
|
10 |
features = NULL, |
|
|
11 |
combine.features = FALSE, |
|
|
12 |
n.tile = 0, |
|
|
13 |
norm = TRUE, |
|
|
14 |
log = FALSE, |
|
|
15 |
assay = NULL, |
|
|
16 |
ncol = 2, |
|
|
17 |
nrow = NULL, |
|
|
18 |
font.size = 2, |
|
|
19 |
pt.size = 1, |
|
|
20 |
keep.scale = "feature", |
|
|
21 |
common.legend = TRUE, |
|
|
22 |
collapse.plots = TRUE |
|
|
23 |
) |
|
|
24 |
} |
|
|
25 |
\arguments{ |
|
|
26 |
\item{object}{a VoltRon object} |
|
|
27 |
|
|
|
28 |
\item{embedding}{the embedding type, i.e. pca, umap etc.} |
|
|
29 |
|
|
|
30 |
\item{features}{a set of features to be visualized, either from \link{vrFeatures} of raw or normalized data or columns of the \link{Metadata}.} |
|
|
31 |
|
|
|
32 |
\item{combine.features}{whether to combine all features in one plot} |
|
|
33 |
|
|
|
34 |
\item{n.tile}{should points be aggregated into tiles before visualization (see \link{geom_tile}). Applicable only for cells and molecules} |
|
|
35 |
|
|
|
36 |
\item{norm}{if TRUE, the normalized data is used} |
|
|
37 |
|
|
|
38 |
\item{log}{if TRUE, data features (excluding metadata features) will be log transformed} |
|
|
39 |
|
|
|
40 |
\item{assay}{assay name (exp: Assay1) or assay class (exp: Visium, Xenium), see \link{SampleMetadata}. |
|
|
41 |
if NULL, the default assay will be used, see \link{vrMainAssay}.} |
|
|
42 |
|
|
|
43 |
\item{ncol}{column wise number of plots, for \link{ggarrange}} |
|
|
44 |
|
|
|
45 |
\item{nrow}{row wise number of plots, for \link{ggarrange}} |
|
|
46 |
|
|
|
47 |
\item{font.size}{font size} |
|
|
48 |
|
|
|
49 |
\item{pt.size}{point size} |
|
|
50 |
|
|
|
51 |
\item{keep.scale}{whether unify all scales for all features or not} |
|
|
52 |
|
|
|
53 |
\item{common.legend}{whether to use a common legend for all plots, see \link{ggarrange}} |
|
|
54 |
|
|
|
55 |
\item{collapse.plots}{whether to combine all ggplots} |
|
|
56 |
} |
|
|
57 |
\description{ |
|
|
58 |
Plotting features of spatially resolved cells and spots on embeddings from multiple assays in a VoltRon object. |
|
|
59 |
} |