File: dotQA-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 (51 lines) | stat: -rw-r--r-- 1,159 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
\name{.QA-class}
\docType{class}
\alias{.QA-class}
\alias{rbind,.QA-method}
\alias{show,.QA-method}

\title{Virtual class for representing quality assessment results}
\description{

  Classes derived from \code{.QA-class} represent results of quality
  assurance analyses. Details of derived class structure are found on
  the help pages of the derived classes.

}

\section{Objects from the Class}{
  Objects from the class are created by ShortRead functions, in
  particular \code{\link{qa}}.
}

\section{Extends}{
  Class \code{"\linkS4class{.ShortReadBase}"}, directly.
}

\section{Methods}{
  
  Methods defined on this class include:

  \describe{

    \item{rbind}{\code{signature(...="list")}: rbind data frame objects
      in \code{...}. All objects of \code{...} must be of the same
      class; the return value is an instance of that class.}

    \item{show}{\code{signature(object = "SolexaExportQA")}: Display an
      overview of the object contents.}

  }
}

\seealso{
  Specific classes derived from \code{.QA}
}

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

\examples{
getClass(".QA", where=getNamespace("ShortRead"))
}

\keyword{classes}