File: alphabetScore.Rd

package info (click to toggle)
r-bioc-shortread 1.32.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 8,384 kB
  • ctags: 293
  • sloc: ansic: 2,718; cpp: 202; sh: 3; makefile: 2
file content (27 lines) | stat: -rw-r--r-- 632 bytes parent folder | download | duplicates (3)
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
\name{alphabetScore}
\alias{alphabetScore}

\title{Efficiently calculate the sum of quality scores across bases}
\description{

  This generic takes a \code{\linkS4class{QualityScore}} or
  \code{PhredQuality} object and calculates, for each read, the sum of
  the encoded nucleotide probabilities.

}
\usage{
alphabetScore(object, ...)
}

\arguments{
  \item{object}{An object of class \code{\linkS4class{QualityScore}}.}
  \item{\dots}{Additional arguments, currently unused.}
}

\value{
  A vector of numeric values of length equal to the length of
  \code{object}.
}
\author{Martin Morgan <mtmorgan@fhcrc.org>}

\keyword{manip}