annotate spp/man/writewig.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{writewig}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
2 \alias{writewig}
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{ A function to save a list of chromosome-wise x/y data frames
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
5 into a WIG file format. }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
6 \description{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
7 Takes a list that contains an $x and $y data.frame for a number of
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
8 chromosomes and writes it out to a WIG BED style format.
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
9 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
10 \usage{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
11 writewig(dat, fname, feature, threshold = 5, zip = F)
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{dat}{ Chromosome coordinate-value data. \code{dat} is a list,
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
16 each member of a list is a data frame with $x and $y columns
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
17 containing chromosome positions and associated values. The names of
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
18 the list elements correspond to the chromosomes. }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
19 \item{fname}{ Filename to which the output should be written }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
20 \item{feature}{ Data description to be incorporated into the WIG header }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
21 \item{threshold}{ Optional threshold to be saved in the WIG file}
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
22 \item{zip}{ Wheter to invoke a zip program to compress the file }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
23 }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
24
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
25 \seealso{ ~~objects to See Also as \code{\link{help}}, ~~~ }
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
26 \examples{
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
27
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
28 data <- list("chr1"=data.frame(x=c(100,130,200),y=c(1.2,4.0,2.3)));
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
29 writewig(data,"filename");
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
30
ce08b0efa3fd Uploaded
zzhou
parents:
diff changeset
31 }