annotate spp/man/write.narrowpeak.binding.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{write.narrowpeak.binding}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
2 \alias{write.narrowpeak.binding}
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{ Write out determined binding peaks using narrowPeak format }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
5 \description{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
6 Writes out determined binding positions into a narrowPeak file.
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
7 The region will correspond to associated broad enrichment region, if
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
8 such were added using add.broad.peak.regions method. Otherwise the
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
9 region size will be determined using margin (which defaults to the
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
10 window half size that was used to determine binding positions)
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
11 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
12 \usage{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
13 write.narrowpeak.binding(results, filename,margin=results$whs)
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
14 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
15 %- maybe also 'usage' for other objects documented here.
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
16 \arguments{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
17 \item{results}{ output of the \code{\link{find.binding.positions}} }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
18 \item{filename}{ file name }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
19 \item{margin}{ explicit value of the margin to be used if the borad
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
20 region information is absent (defaults to peak detection window half-size}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
21 }