6
|
1 \name{writewig}
|
|
2 \alias{writewig}
|
|
3 %- Also NEED an '\alias' for EACH other topic documented here.
|
|
4 \title{ A function to save a list of chromosome-wise x/y data frames
|
|
5 into a WIG file format. }
|
|
6 \description{
|
|
7 Takes a list that contains an $x and $y data.frame for a number of
|
|
8 chromosomes and writes it out to a WIG BED style format.
|
|
9 }
|
|
10 \usage{
|
|
11 writewig(dat, fname, feature, threshold = 5, zip = F)
|
|
12 }
|
|
13 %- maybe also 'usage' for other objects documented here.
|
|
14 \arguments{
|
|
15 \item{dat}{ Chromosome coordinate-value data. \code{dat} is a list,
|
|
16 each member of a list is a data frame with $x and $y columns
|
|
17 containing chromosome positions and associated values. The names of
|
|
18 the list elements correspond to the chromosomes. }
|
|
19 \item{fname}{ Filename to which the output should be written }
|
|
20 \item{feature}{ Data description to be incorporated into the WIG header }
|
|
21 \item{threshold}{ Optional threshold to be saved in the WIG file}
|
|
22 \item{zip}{ Wheter to invoke a zip program to compress the file }
|
|
23 }
|
|
24
|
|
25 \seealso{ ~~objects to See Also as \code{\link{help}}, ~~~ }
|
|
26 \examples{
|
|
27
|
|
28 data <- list("chr1"=data.frame(x=c(100,130,200),y=c(1.2,4.0,2.3)));
|
|
29 writewig(data,"filename");
|
|
30
|
|
31 }
|