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
|
\name{get.broad.enrichment.clusters}
\alias{get.broad.enrichment.clusters}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{ Determine broad clusters of enrichment }
\description{
Scan chromosomes with a pre-defined window size, comparing scaled ChIP
and input tag coutns to see if their ratio exceeds that expected from
a Poisson process (normalized for dataset size).
}
\usage{
get.broad.enrichment.clusters(signal.data,
control.data,
window.size=1e3,
z.thr=3,
tag.shift=146/2,
background.density.scaling = F,
...)
}
%- maybe also 'usage' for other objects documented here.
\arguments{
\item{signal.data}{chip.tags, foreground tag vector list }
\item{control.data}{input.tags, background tag vector list }
\item{window.size}{ window size to be used for tag counting }
\item{z.thr}{ Z-score to be used as a significance threshold }
\item{tag.shift}{ number of base pairs by which positive and negative
tag coordinates should be shifted towards eachother (half of binding
peak separation distance)}
\item{background.density.scaling}{ If TRUE, regions of significant tag
enrichment will be masked out when calculating size ratio of the
signal to control datasets (to estimate ratio of the background tag
density). If FALSE, the dataset ratio will be equal to the ratio of
the number of tags in each dataset.}
\item{\dots}{ additional parameters should be the same as those passed
to the \code{find.significantly.enriched.regions}}
}
\value{
A list of elements corresponding to chromosomes, with each element
being an $s/$e/$rv data.frame giving the starting, ending positions and the log2
enrichment estimate for that region.
}
|
