File: matchDistribution.Rd

package info (click to toggle)
r-bioc-cner 1.26.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 18,216 kB
  • sloc: ansic: 23,458; makefile: 6
file content (45 lines) | stat: -rw-r--r-- 1,076 bytes parent folder | download | duplicates (4)
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
42
43
44
45
\name{matchDistribution}
\alias{matchDistribution}
\alias{matchDistribution,Axt-method}
\title{
  Plot the distribution of matched alignments.
}
\description{
  Given a \code{Axt} alignment, plot a heatmap showing the percentage of
  each matched alignments.
}
\usage{
  matchDistribution(x, size=10000, title=NULL)
}

\arguments{
  \item{x}{
    \code{Axt} object.
  }
  \item{size}{
    \code{integer}(1): the number of alignments to use. By default, it is 10000.
  }
  \item{title}{
    \code{character}(1): the customised title for the plot.
  }
}
\details{
  By default, if there are more than 10,000 alignments, 
  10,000 alignments will be sampled and calculated for the distribution
  for speed purposes.
  
  Only the four bases (A, C, G, T), gap (-) and any (N) are displayed. 
  Other ambiguous bases are not considered.
}
\value{
  A ggplot2 object will be returned.
}
\author{
  Ge Tan
}
\examples{
  axtFile <- file.path(system.file("extdata", package="CNEr"), 
                       "hg38.danRer10.net.axt")
  axt <- readAxt(axtFile)
  matchDistribution(axt)
}