File: readPrb.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 (85 lines) | stat: -rw-r--r-- 2,051 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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
\name{readPrb}

\alias{readPrb}
\alias{readPrb,character-method}

\title{(Legacy) Read Solexa prb files as fastq-style quality scores}

\description{

  \code{readPrb} reads all \code{_prb.txt} files in a directory into a
  single object. Most methods (see details) do this by identifying the
  maximum base call quality for each cycle and read, and representing
  this as an ASCII-encoded character string.

}
\usage{
readPrb(dirPath, pattern = character(0), ...)
}

\arguments{

  \item{dirPath}{Directory path or other object (e.g.,
    \code{\linkS4class{SolexaPath}} for which methods are defined.}

  \item{pattern}{Regular expression matching names of \code{_prb} files
    to be summarized.}

  \item{\dots}{Additional arguments, unused.}

}

\details{

  The \code{readPrb,character-method} contains an argument \code{as}
  that determines the value of the returned object, as follows.

  \describe{

    \item{\code{as="SolexaEncoding"}}{

      The ASCII encoding of the maximum per cycle and read quality score
      is encoded using Solexa conventions.

    }

    \item{\code{as="FastqEncoding"}}{

      The ASCII encoding of the maximum per cycle and read quality score
      is encoded using Fastq conventions, i.e., \code{!} has value 0.

    }

    \item{\code{as="IntegerEncoding"}}{

      The maximum per cycle and read quality score is returned as a in
      integer value. Values are collated into a matrix with number of
      rows equal to number of reads, and number of columns equal to
      number of cycles.

    }

    \item{\code{as="array"}}{

      The quality scores are \emph{not} summarized; the return value is
      an integer array with dimensions corresponding to reads,
      nucleotides, and cycles.

    }

  }
}

\value{
  An object of class \code{\linkS4class{QualityScore}}, or an integer matrix.
}

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

\examples{
fl <- system.file("extdata", package="ShortRead")
sp <- SolexaPath(fl)
readPrb(sp, "s_1.*_prb.txt") # all tiles to a single file
}

\keyword{manip}