2
|
1 \name{MosaicsPeak-class}
|
|
2 \Rdversion{1.1}
|
|
3 \docType{class}
|
|
4 \alias{MosaicsPeak-class}
|
|
5 \alias{bdBin,MosaicsPeak-method}
|
|
6 \alias{empFDR,MosaicsPeak-method}
|
|
7 %\alias{export,MosaicsPeak-method}
|
|
8 \alias{print,MosaicsPeak-method}
|
|
9 \alias{show,MosaicsPeak-method}
|
|
10
|
|
11 \title{Class "MosaicsPeak" }
|
|
12 \description{
|
|
13 This class represents peak calling results.
|
|
14 }
|
|
15 \section{Objects from the Class}{
|
|
16 Objects can be created by calls of the form \code{new("MosaicsPeak", ...)}.
|
|
17 }
|
|
18 \section{Slots}{
|
|
19 \describe{
|
|
20 \item{\code{peakList}:}{Object of class \code{"data.frame"}, representing peak list. }
|
|
21 \item{\code{peakParam}:}{Object of class \code{"MosaicsPeakParam"},
|
|
22 representing parameters for peak calling. }
|
|
23 \item{\code{bdBin}:}{Object of class \code{"numeric"},
|
|
24 representing a vector of bounded bins. }
|
|
25 \item{\code{empFDR}:}{Object of class \code{"numeric"},
|
|
26 representing empirical FDR. }
|
|
27 }
|
|
28 }
|
|
29 \section{Methods}{
|
|
30 \describe{
|
|
31 \item{export}{\code{signature(object = "MosaicsPeak")}: export peak list into text files. }
|
|
32 \item{print}{\code{signature(x = "MosaicsPeak")}: return peak list in data frame format. }
|
|
33 \item{show}{\code{signature(object = "MosaicsPeak")}: provide brief summary of the object. }
|
|
34 }
|
|
35 }
|
|
36 \references{
|
|
37 Kuan, PF, D Chung, G Pan, JA Thomson, R Stewart, and S Keles (2011),
|
|
38 "A Statistical Framework for the Analysis of ChIP-Seq Data",
|
|
39 \emph{Journal of the American Statistical Association}, Vol. 106, pp. 891-903.
|
|
40 }
|
|
41 \author{ Dongjun Chung, Pei Fen Kuan, Sunduz Keles }
|
|
42 \seealso{
|
|
43 \code{\link{mosaicsPeak}}, \code{\link{export}}.
|
|
44 }
|
|
45 \examples{
|
|
46 showClass("MosaicsPeak")
|
|
47 \dontrun{
|
|
48 library(mosaicsExample)
|
|
49 data(exampleFit)
|
|
50 examplePeak <- mosaicsPeak( exampleFit, signalModel = "2S", FDR = 0.05 )
|
|
51
|
|
52 examplePeak
|
|
53 print(examplePeak)[1:10, ]
|
|
54 export( examplePeak, type = "txt", filename = "./TSpeakList.txt" )
|
|
55 export( examplePeak, type = "bed", filename = "./TSpeakList.bed" )
|
|
56 export( examplePeak, type = "gff", filename = "./TSpeakList.gff" )
|
|
57 }
|
|
58 }
|
|
59 \keyword{classes}
|