Last data update: 2014.03.03

R: Call peaks and obtain combinatorial enrichment patterns
jmosaicsPatternR Documentation

Call peaks and obtain combinatorial enrichment patterns

Description

Call peaks and obtain combinatorial enrichment patterns

Usage

jmosaicsPattern(fit_all,region_length,FDR,thres=NULL,type=c('B','E','Pattern'),patternInfo='FALSE')

Arguments

fit_all

A list of fitted MOSAiCS models obtained using function mosaicsFit.

region_length

Region length, the number of bins covered by each region.

FDR

False discovery rate.

thres

A peak within initial peak is removed if its ChIP tag counts are less than thres. thres could be NULL or a numeric vector, corresponding to each dataset. If NULL, no threshold for average ChIP tag counts for all data sets would be used. Default is NULL.

type

a vector of characters to decide which objects would be returned. Possible values are 'E': return E_LAYER result; 'B': return B_LAYER result and 'Pattern': return Pattern (enrichment pattern).

patternInfo

Parameter for returning information on regions. Possible values are TRUE (return information on regions) or FALSE (do not return information on regions). Default is FALSE.

Details

The function returns objects based on ‘type’. 'B_LAYER' object is a list of regions which are enriched in at least one dataset. Peak information can be accessed by ‘chrID’, ‘PeakStart’, ‘PeakStop’, ‘Postprob’(P(B=0jdata information)), ‘aveChipCount E_*’, ‘aveInputCount E_*’. * indicates the index of the datasets, for example: aveChipCount E_1 is the average tagCount for the first dataset. Each list of 'E_LAYER' object reports enriched regions for each dataset which can be accessed by ‘chrID’, ‘PeakStart’, ‘PeakStop’, ‘Postprob’(P(E=0j data sets)), ‘aveChipCount’, ‘maxChipCount’, ‘aveInputCount’, '‘aveInputCountScaled’, ‘aveLog2Ratio’. If region length is 1, it can be accessed by ‘chrID’, ‘PeakStart’, ‘PeakStop’, ‘Postprob’, ‘ChipCount’, ‘InputCount’, 'Input- CountScaled', ‘Log2Ratio’. In the object of Pattern, it reports the enrichment patterns to the regions which cover the whole genome. When the region covering more than one bin, to get the average ChIP and input tagCount would be time consuming, the argument of 'patternInfo' let users decide whether to report the average ChIP and input tagCount.

Value

A list with following components:

E_LAYER

lists of enriched E regions, each list includes enriched regions for each data set.

B_LAYER

list of enriched B regions.

Pattern

list of regions annotated with patterns.

Author(s)

Xin Zeng

Examples

data("jmosaics_example_data")
bin <- readBinsMultiple(origin_bin)
fit1 <- mosaicsFit(bin[[1]], analysisType = "IO")
fit2 <- mosaicsFit(bin[[2]], analysisType = "IO")
fit <- list(fit1,fit2)
result <- jmosaicsPattern(fit, region_length=1, FDR=0.01, thres=c(10,10), type=c('B','E','Pattern'), patternInfo='FALSE')

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(jmosaics)
Loading required package: mosaics
Loading required package: Rcpp
> png(filename="/home/ddbj/snapshot/RGM3/R_BC/result/jmosaics/jmosaicsPattern.Rd_%03d_medium.png", width=480, height=480)
> ### Name: jmosaicsPattern
> ### Title: Call peaks and obtain combinatorial enrichment patterns
> ### Aliases: jmosaicsPattern
> ### Keywords: models methods
> 
> ### ** Examples
> 
> data("jmosaics_example_data")
> bin <- readBinsMultiple(origin_bin)
> fit1 <- mosaicsFit(bin[[1]], analysisType = "IO")
Info: background estimation based on robust method of moment.
Info: two-sample analysis (Input only).
Info: use adaptive griding.
Info: fitting background model...
Info: done!
Info: fitting one-signal-component model...
Info: fitting two-signal-component model...
Info: calculating BIC of fitted models...
Error in initialize(value, ...) : 
  no slot of name "seqDepth" for this object of class "BinData"
Calls: mosaicsFit ... .local -> .mosaicsFit_IO -> new -> initialize -> initialize
Execution halted