File: RtaIntensity-class.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 (64 lines) | stat: -rw-r--r-- 1,808 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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
\name{RtaIntensity-class}
\docType{class}
\alias{RtaIntensity-class}

\title{(Legacy) Class "RtaIntensity"}
\description{

  Subclass of \code{\linkS4class{Intensity}} for representing image
  intensity data from the Illumina RTA pipeline.

}
\section{Objects from the Class}{

  Objects can be created by calls to \code{RtaIntensity} or more usually
  \code{readIntensities}.

}
\section{Slots}{

  Object of \code{RtaIntensity} have slots:

  \describe{

    \item{\code{readInfo}:}{Object of class \code{"RtaIntensityInfo"}
      representing information about each read.}

    \item{\code{intensity}:}{Object of class \code{"ArrayIntensity"}
      containing an array of intensities with dimensions read, base, and
      cycle. Nucleotide are A, C, G, T for each cycle.}

    \item{\code{measurementError}:}{Object of class
      \code{"ArrayIntensity"} containing measurement errors for each
      read, cycle, and base, with dimensions like that for
      \code{intensity}. }

    \item{\code{.hasMeasurementError}:}{Object of class
      \code{"ScalarLogical"} used internally to indicate whether
      measurement error information is included.}
  }

}
\section{Extends}{

  Class \code{"\linkS4class{SolexaIntensity}"}, directly.

  Class \code{"\linkS4class{Intensity}"}, by class "SolexaIntensity", distance 2.

  Class \code{"\linkS4class{.ShortReadBase}"}, by class "SolexaIntensity", distance 3.
}
\section{Methods}{

  Class "RtaIntensity" inherits accessor, subsetting, and display
  methods from class \code{\linkS4class{SolexaIntensity}}.

}
\author{Martin Morgan <mtmorgan@fhcrc.org>}

\seealso{\code{\linkS4class{SolexaIntensity}}, \code{\link{readIntensities}}}

\examples{
showClass("RtaIntensity")
showMethods(class="RtaIntensity", where=getNamespace("ShortRead"))
}
\keyword{classes}