Usage
DBChIP(binding.site.list, chip.data.list, conds, input.data.list = NULL, data.type = c("MCS", "AlignedRead", "BED"), frag.len = 200, chr.vec = NULL, chr.exclusion = NULL, chr.len.vec = NULL, subtract.input = FALSE, norm.factor.vec = NULL, in.distance = 100, out.distance = 250, window.size = 250, dispersion=NULL, common.disp=TRUE, prior.n=10, two.sample.method="composite.null", allowable.FC=1.5, collapsed.quant=0.5)
Arguments
binding.site.list
a list of data.frames. Each data.frame corresponds to one condition in comparison
and has three fields, chr, pos, and weight, to indicate the binding location and strength.
chip.data.list
a list of ChIP data where each list item corresponds to one ChIP library. The name of the items should be unique. Biological replicates should be in separate items. Each item can be one of three accepted data types: MCS, AlignedRead and BED.
conds
a vector of conditions of ChIP libraries. Should be the same order as chip.data.list, or the names should be specified as a permutation of the names of chip.data.list.
input.data.list
a list of control data. Should have same data type as in chip.data.list. The names of the items should be unique, and each name should be matched to either a ChIP replicate name when the two are paired or a condition name in general.
data.type
"MCS", "AlignedRead" or "BED". See Details.
frag.len
average fragment length. Default 200 bp.
chr.vec
a vector of chromosomes in data. User can specify chr.vec, or it can be computed from the ChIP and control samples.
chr.exclusion
user can either specify chr.vec, or specify the chromosomes to exclude through this parameter.
chr.len.vec
a vector of chromosome lengths corresponding to chr.vec. Can be specified if known, or will be computed as the largest 5' end position in the data.
subtract.input
logical. Whether input will be subtracted from ChIP when counting the binding reads. Default is FALSE.
norm.factor.vec
a vector of normalization factors between the ChIP and control libraries when controls are available. Can be specified, or will be computed by DBChIP.
in.distance
within cluster distance. If the distance between centroids of two clusters are smaller than this value, the clusters will be merged into one. Default value 100 bp.
out.distance
out of cluster distance. If the distance between centroids of two clusters are larger than this value, they are considered different binding sites. Also double-function as the window size to count reads around each site. Default value 250 bp.
window.size
the window size to count reads around a binding site.
dispersion
The dispersion parameter in Negative Binomial distribution. Could be a numerical value or a vector with a length of the number of consensus sites.
common.disp
logical, TRUE (use common dispersion parameter for all sites) or FALSE (use site-specific dispersion).
prior.n
a parameter regulate the degree of pooling when using site-specific dispersion (common.disp
=FALSE).
two.sample.method
the method to use when comparing two condition with no replicates. The default is to test a composite null that allow certain fold change allowable.FC
. Otherwise user should provide a dispersion parameter.
allowable.FC
allowable fold change when testing a composite null. Default value 1.5.
collapsed.quant
the quantile to use when testing more than two conditions without replicates. Default value is 0.5, the median.