File: vis.number.count.Rd

package info (click to toggle)
r-cran-tcr 2.3.2%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, trixie
  • size: 2,316 kB
  • sloc: cpp: 187; makefile: 5
file content (41 lines) | stat: -rw-r--r-- 1,083 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plots.R
\name{vis.number.count}
\alias{vis.number.count}
\title{Plot a histogram of counts.}
\usage{
vis.number.count(
  .data,
  .ncol = 3,
  .name = "Histogram of clonotypes read counts",
  .col = "Read.count"
)
}
\arguments{
\item{.data}{Cloneset data frame or a list of clonesets.}

\item{.ncol}{If .data is a list, than number of columns in a grid of histograms for each data frame in \code{.data}. Else not used.}

\item{.name}{Title for this plot.}

\item{.col}{Name of the column with counts.}
}
\value{
ggplot object.
}
\description{
Plot a histogram of distribution of counts of CDR3 nucleotide sequences. On y-axis are number of counts.
}
\details{
If \code{.data} is a data frame, than one histogram will be plotted. Is \code{.data} is a list, than grid of histograms
will be plotted.
}
\examples{
\dontrun{
load('immdata.rda')
# Plot one histogram with main title.
vis.number.count(immdata[[1]], 'Main title here')
# Plot a grid of histograms with 2 columns.
vis.number.count(immdata, 2)
}
}