File: AlignedRead.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 (54 lines) | stat: -rw-r--r-- 1,762 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
\name{AlignedRead}
\alias{AlignedRead}

\title{(Legacy) Construct objects of class "AlignedRead"}
\description{

  This function constructs objects of
  \code{\linkS4class{AlignedRead}}. It will often be more convenient to
  create \code{AlignedRead} objects using parsers such as
  \code{\link{readAligned}}.

}
\usage{
AlignedRead(sread, id, quality, chromosome, position, strand,
            alignQuality,
            alignData = AlignedDataFrame(nrow = length(sread)))
}

\arguments{
  \item{sread}{An object of class \code{DNAStringSet}, containing the
    DNA sequences of the short reads.}

  \item{id}{An object of class \code{BStringSet}, containing the
    identifiers of the short reads. This object is the same length as
    \code{sread}.}

  \item{quality}{An object of class \code{BStringSet}, containing the
    ASCII-encoded quality scores of the short reads. This object is the
    same length as \code{sread}.}

  \item{chromosome}{A \code{factor} describing the particular sequence
    within a set of target sequences (e.g. chromosomes in a genome
    assembly) to which each short read aligns.}

  \item{position}{A \code{integer} vector describing the (base pair)
    position at which each short read begins its alignment.}

  \item{strand}{A \code{factor} describing the strand to which the short
    read aligns.}

  \item{alignQuality}{A \code{numeric} vector describing the alignment
    quality.}

  \item{alignData}{An \code{AlignedDataFrame} with number of rows equal
    to the length of \code{sread}, containing additional information
    about alignments.}
}
\value{
  An object of class \code{\linkS4class{AlignedRead}}.
}

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