File: SolexaIntensity.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 (65 lines) | stat: -rw-r--r-- 2,023 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
65
\name{SolexaIntensity}
\alias{SolexaIntensity}
\alias{SolexaIntensityInfo}

\title{(Legacy) Construct objects of class "SolexaIntensity" and
"SolexaIntensityInfo"}

\description{

  These function constructs objects of
  \code{\linkS4class{SolexaIntensity}} and
  \code{\linkS4class{SolexaIntensityInfo}}. It will often be more
  convenient to create these objects using parsers such as
  \code{\link{readIntensities}}.

}
\usage{
SolexaIntensity(intensity=array(0, c(0, 0, 0)),
                measurementError=array(0, c(0, 0, 0)),
                readInfo=SolexaIntensityInfo(
                  lane=integer(nrow(intensity))),
                ...)
SolexaIntensityInfo(lane=integer(0),
                    tile=integer(0)[seq_along(lane)],
                    x=integer(0)[seq_along(lane)],
                    y=integer(0)[seq_along(lane)])
}

\arguments{

  \item{intensity}{A matrix of image intensity values. Successive
    columns correspond to nucleotides A, C, G, T; four successive
    columns correspond to each cycle. Typically, derived from
    \code{"_int.txt"} files.}

  \item{measurementError}{As \code{intensity}, but measuring standard
    error. Usually derived from \code{"_nse.txt"} files.}

  \item{readInfo}{An object of class \code{AnnotatedDataFrame},
    containing information described by \code{SolexaIntensityInfo}.}

  \item{lane}{An integer vector giving the lane from which each read is
    derived.}

  \item{tile}{An integer vector giving the tile from which each read is
    derived.}

  \item{x}{An integer vector giving the tile-local x coordinate of the
    read from which each read is derived.}

  \item{y}{An integer vector giving the tile-local y coordinate of the
    read from which each read is derived.}

  \item{...}{Additional arguments, not currently used.}
}
\value{

  An object of class \code{\linkS4class{SolexaIntensity}}, or
  \code{SolexaIntensityInfo}.

}

\author{Martin Morgan <mtmorgan@fhcrc.org>}
\seealso{\code{\linkS4class{SolexaIntensity}}.}
\keyword{manip}