Diff of /man/cellVisualization.Rd [000000] .. [4a0329]

Switch to unified view

a b/man/cellVisualization.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/scAI_plotting.R
3
\name{cellVisualization}
4
\alias{cellVisualization}
5
\title{visualize cells in 2D-dimensional space}
6
\usage{
7
cellVisualization(object, cell_coords, color.by, labels.order = NULL,
8
  colors.use = NULL, brewer.use = FALSE, xlabel = "UMAP1",
9
  ylabel = "UMAP2", title = NULL, label.size = 4, cell.size = 0.3,
10
  font.size = 10, do.label = F, show.legend = T, show.axes = T)
11
}
12
\arguments{
13
\item{object}{scAI object}
14
15
\item{cell_coords}{2D embedding coordinates of cells}
16
17
\item{color.by}{the name of the variable in pData, defining cell groups, cells are colored based on the labels}
18
19
\item{labels.order}{defining the factor level of cell groups}
20
21
\item{colors.use}{defining the color for each cell group}
22
23
\item{brewer.use}{use RColorBrewer palette instead of default ggplot2 color}
24
25
\item{xlabel}{label of x-axis}
26
27
\item{ylabel}{label of y-axis}
28
29
\item{title}{main title of the plot}
30
31
\item{label.size}{font size of the legend}
32
33
\item{cell.size}{size of the dots}
34
35
\item{font.size}{font size}
36
37
\item{do.label}{label the cluster in 2D space}
38
39
\item{show.legend}{whether show the legend}
40
41
\item{show.axes}{whether show the axes}
42
}
43
\value{
44
ggplot2 object with 2D plot
45
}
46
\description{
47
visualize cells in 2D-dimensional space
48
}