annotate mosaics/man/MosaicsPeak-class.Rd @ 10:d78c3c5e8ff8 draft

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