annotate spp/man/get.smoothed.enrichment.mle.Rd @ 6:ce08b0efa3fd draft

Uploaded
author zzhou
date Tue, 27 Nov 2012 16:11:40 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
1 \name{get.smoothed.enrichment.mle}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
2 \alias{get.smoothed.enrichment.mle}
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{ Calculate chromosome-wide profiles of smoothed enrichment estimate }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
5 \description{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
6 Given signal and control tag positions, the method calculates log2
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
7 signal to control enrichment esimates (maximum likelihood) for each
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
8 chromosome, based on the smoothed tag density profile (see \link{get.smoothed.tag.density}).
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
9 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
10 \usage{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
11 get.smoothed.enrichment.mle(signal.tags, control.tags, bandwidth = 150,tag.shift = 146/2, step = 50)
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{signal.tags}{ signal chromosome tag coordinate vectors (e.g. output
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
16 of \code{\link{select.informative.tags}} }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
17 \item{control.tags}{ control (input) tags }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
18 \item{pseudocount}{ pseudocount value to be added to tag density -
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
19 defaults to 1 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
20 other parameters (such as bandwidth, step.size and tag.shift) are
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
21 passed to \link{get.smoothed.tag.density} - see appropriate reference
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
22 for details.
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
23 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
24 \value{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
25 A list of elements corresponding to chromosomes, with each element
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
26 being an $x/$y data.frame giving the position and associated
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
27 log2 signal/control enrichment estimate.
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
28 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
29 \seealso{ \code{\link{writewig}} }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
30 \examples{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
31 # get smoothed enrichment estimate profile using 500bp bandwidth at
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
32 # 50bp steps
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
33 smoothed.M <- get.smoothed.enrichment.mle(chip.data,bandwidth=500,step=50);
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
34 writewig(smoothed.M,"example.smoothedM.wig","Example smoothed log2 intensity ratio estimate");
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
35 }