annotate spp/man/output.binding.results.Rd @ 10:59a81e527e3c draft

Uploaded
author zzhou
date Tue, 27 Nov 2012 16:14:35 -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{output.binding.results}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
2 \alias{output.binding.results}
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 into a text file table }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
5 \description{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
6 Writes out determined binding positions into a text file. The file
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
7 will contain a table with each row corresponding to a detected
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
8 position, with the following columns:
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
9 \item{chr}{ chromosome or target sequence }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
10 \item{pos}{ position of detected binding site on the chromosome/sequence}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
11 \item{score}{a score reflecting magnitude of the binding}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
12 \item{Evalue}{E-value corresponding to the peak magnitude}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
13 \item{FDR}{FDR corresponding to the peak magnitude}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
14 \item{enrichment.lb}{lower bound of the fold-enrichment ratio}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
15 \item{enrichment.mle}{maximum likelihood estimate of the fold-enrichment ratio}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
16 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
17 \usage{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
18 output.binding.results(results, filename)
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
19 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
20 %- maybe also 'usage' for other objects documented here.
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
21 \arguments{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
22 \item{results}{ output of the \code{\link{find.binding.positions}} }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
23 \item{filename}{ file name }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
24 }