annotate spp/man/get.broad.enrichment.clusters.Rd @ 15:e689b83b0257 draft

Uploaded
author zzhou
date Tue, 27 Nov 2012 16:15:21 -0500
parents ce08b0efa3fd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
1 \name{get.broad.enrichment.clusters}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
2 \alias{get.broad.enrichment.clusters}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
3 %- Also NEED an '\alias' for EACH other topic documented here.
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
4 \title{ Determine broad clusters of enrichment }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
5 \description{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
6 Scan chromosomes with a pre-defined window size, comparing scaled ChIP
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
7 and input tag coutns to see if their ratio exceeds that expected from
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
8 a Poisson process (normalized for dataset size).
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
9 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
10 \usage{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
11 get.broad.enrichment.clusters(chip.tags, input.tags, window.size=1e3,z.thr=3,tag.shift=146/2)
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
12 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
13 %- maybe also 'usage' for other objects documented here.
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
14 \arguments{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
15 \item{chip.tags}{ foreground tag vector list }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
16 \item{input.tags}{ background tag vector list }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
17 \item{window.size}{ window size to be used for tag counting }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
18 \item{z.thr}{ Z-score to be used as a significance threshold }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
19 \item{tag.shift}{ number of base pairs by which positive and negative
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
20 tag coordinates should be shifted towards eachother (half of binding
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
21 peak separation distance)}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
22 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
23 \value{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
24 A list of elements corresponding to chromosomes, with each element
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
25 being an $s/$e/$rv data.frame giving the starting, ending positions and the log2
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
26 enrichment estimate for that region.
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
27 }