annotate spp/man/add.broad.peak.regions.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{add.broad.peak.regions}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
2 \alias{add.broad.peak.regions}
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 tag density }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
5 \description{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
6 Looks for broader regions of enrichment associated with the determined
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
7 peak positions, adds them to the $npl data as $rs, $re columns.
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
8 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
9 \usage{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
10 add.broad.peak.regions(signal.tags, control.tags, binding.postions,window.size=500,z.thr=2)
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
11 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
12 %- maybe also 'usage' for other objects documented here.
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
13 \arguments{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
14 \item{signal.tags}{ signal chromosome tag coordinate vectors (e.g. output
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
15 of \code{\link{select.informative.tags}} }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
16 \item{control.tags}{ optionall control (input) tags }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
17 \item{binding.positions}{ output of find.binding.positions call }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
18 \item{window.size}{ window size to be used in calculating enrichment }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
19 \item{z.thr}{ Z-score corresponding to the Poisson ratio threshold
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
20 used to flag significantly enriched windows}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
21 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
22 \value{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
23 A structure identical to binding.postions with two additional columns
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
24 added (rs and re) corresponding to start and end of the associated
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
25 significantly enriched region. If no region was associated with a
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
26 particular peak, NAs values are reported.
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
27 }